False positive on const missing comment

[MarcelXia]

Describe the bug
False positive : exported const TTLkey should have comment (or a comment on this block) or be unexported

To Reproduce

const (
	TTLKey       = "ttl"    // Tome to live key
)

When the comment is above it, it won't complain, but when it is after it (same line) it complains.

Using revive 1.2.1
Command:
revive -formatter friendly -exclude ./vendor/... ./...

[chavacava]

Hi @MarcelXia, thanks for filling the issue.

[ifooth]

same issue +1

[chavacava]

Hi, I've created the PR #700

GO parser makes the difference between comment and documentation

// this is "documentation"
const AConst = 1 // this is a "comment"

revive checks the content of documentation. For example in the following code it will complain if the documentation text does not start with the name of the constant

const (
	// Time to live key
	TTLKey       = "ttl"    
)

The PR, applies the same checks to comments, i.e. on

const (
	TTLKey       = "ttl"    // Time to live key
)

it will complain because the comment is not of the form TTLKey ...
Another thing, if a declaration has a documentation and a comment it will check only the documentation

const (
	// TTLKey is the time to live key
	TTLKey       = "ttl"    // always in lowercase
)

What do you think?

[MarcelXia]

I'm not sure, have to check myself, but I think the Go parser "knows" the comments or documentation belongs to a command.
For my (being a silly human) the fact that it is clear by the comment above or after the line is enough.

[chavacava]

I'm not sure, have to check myself, but I think the Go parser "knows" the comments or documentation belongs to a command. For my (being a silly human) the fact that it is clear by the comment above or after the line is enough.

Sure, the parser attaches documentation and comments to statements.
My question is about the pertinence of enforcing on comments the same style rules that are enforced on documentation (case 3 below)

There are the following cases:
Case 1: no doc, no comment

const (
	TTLKey       = "ttl"  
)

revive will complain about the absence of doc

Case 2: doc, no comment

const (
	// TTLKey is the time to live key
	TTLKey       = "ttl"
)

revive will complain iff the doc style is not respected (it must start with TTLKey ...)

Case 3: no doc, comment

const (
	TTLKey       = "ttl" // TTLKey is the time to live key
)

revive will complain iff the comment style is not respected (it must start with TTLKey ...)

Case 4: doc and comment

const (
	// TTLKey is the time to live key
	TTLKey       = "ttl"    // always in lowercase
)

revive will complain iff the doc style is not respected (it must start with TTLKey ...).
Comment style is not checked.

That behavior is OK for you?