Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report missing godoc comments #115

Closed
knweiss opened this issue Jun 3, 2017 · 5 comments
Closed

Report missing godoc comments #115

knweiss opened this issue Jun 3, 2017 · 5 comments

Comments

@knweiss
Copy link

knweiss commented Jun 3, 2017

I'm not sure if megacheck is the right command for this but I would love to see an optional feature that reports missing godoc comments (at least for exported functions).

Or is there already an existing tool for this functionality that I'm not aware of?

@dmitshur
Copy link
Contributor

dmitshur commented Jun 3, 2017

I believe this is one of the primary uses of golint.

@knweiss
Copy link
Author

knweiss commented Jun 3, 2017

@shurcooL Ah, golint is what I was missing. Thank you!

@knweiss knweiss closed this as completed Jun 3, 2017
@bufdev
Copy link

bufdev commented May 31, 2020

Can this be revived in light of golang/go#38968

@dominikh
Copy link
Owner

dominikh commented Jun 1, 2020

@bufdev Yes. This is on my todo list.

@sbward
Copy link

sbward commented May 4, 2021

Came here to say I was surprised when suddenly VSCode had stopped reporting missing godoc comments on my exported types and values. That's when I noticed the default linter is now staticcheck! It's been almost a year since the last comment on this issue -- please re-open it soon 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants