Inspectopedia Help

Exported element should have a comment

Reports exported declarations without a documentation comment. According to Doc Comments at github.com/golang, all top-level exported names should have doc comments.

Also, for more information about comment sentences, see Comment Sentences at github.com/golang.

To add a comment, you can apply the Add comment quick-fix.

Inspection Details

Available in:

GoLand 2023.3

Plugin:

Go, 233.SNAPSHOT

Last modified: 13 July 2023