Inspectopedia
 
2024.3

Comment of exported element starts with the incorrect name

Info
Code Style
New
Last modified: 03 December 2024

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:

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