detects whether declarations of exported variables, constants, functions, etc. have comments.

[cold-bin]

Welcome

• [X] Yes, I've searched similar issues on GitHub and didn't find any.
• [X] I agree to follow this project's Code of Conduct

Your feature request related to a problem? Please describe

When a new person takes over a large project, it will be painful if there are no comments. This is how I feel that necessary comments need to be provided for public types, variables, functions or methods to facilitate the new person to quickly familiarize themselves with the project.

Describe the solution you'd like

use go/analyze package to recursive traversal ast comment or documention node. if empty the comment and documention node, then call reportf. the link of https://github.com/cold-bin/declaration-comment is my implement

Describe alternatives you've considered

nothing, this way can solve no comments of many complex type

Additional context

No response

Supporter

• [ ] I am a sponsor through GitHub or OpenCollective

[boring-cyborg[bot]]

Hey, thank you for opening your first Issue ! 🙂 If you would like to contribute we have a guide for contributors.

[ldez]

Hello,

this already exists inside golangci-lint: revive, stylecheck, etc.

[ccoVeille]

The only existing linter I know that looks like what is requested would be revive:comment-density

https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#comments-density

[cold-bin]

thank for your reply

[ldez]

The only existing linter I know that looks like what is requested would be revive:comment-density

This issue is about comments, so there several rules inside revive and stylecheck.

But remember that by default, golangci-lint skips those reports.

https://golangci-lint.run/usage/false-positives/#default-exclusions

To disable those exclusions:

issues:
  exclude-use-default: false

[ccoVeille]

Thanks for providing this information. I totally missed that parameter even I'm using golangci-lint for a while.

I'll have a look, thanks