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, refer to Comment Sentences at github.com/golang.

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

Inspection Details

By default bundled with:

GoLand 2024.1, Qodana for Go 2024.1,

Can be installed with plugin:

Go, 241.SNAPSHOT

Last modified: 29 April 2024