Inspectopedia Help

Comment of exported element starts with the incorrect name

Reports comments that do not start with the name of the exported element.

According to Comment Sentences at github.com/golang, this is a convention to begin a comment with the name of the exported element.

Example:

// represents a request to run a command. type Request struct {}

The comment starts with the struct description, not with the struct name. To stick to the convention rules, you can apply the Add prefix to comment quick-fix. After the quick-fix is applied, the comment looks as follows:

// Request represents a request to run a command. type Request struct {} // better

Inspection Details

Available in:

GoLand 2023.3

Plugin:

Go, 233.SNAPSHOT

Last modified: 13 July 2023