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.

Locating this inspection

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

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Go | Code style issues

Availability

By default bundled with: GoLand 2024.1, Qodana for Go 2024.1,
Can be installed with plugin: Go, 241.SNAPSHOT

Last modified: 18 June 2024