Go
Exported element should have a comment
Info
Code Style
New
Last modified: 03 December 2024Reports 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.
- By ID
Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.
GoExportedElementShouldHaveComment
Inspection Details | |
---|---|
By default bundled with: | |
Can be installed with plugin: | Go, 243.23131 |
Thanks for your feedback!
Was this page helpful?