godoclint

Documentation

Overview

Command godoclint reports exported symbols that carry no useful documentation.

"Useful" is doing work in that sentence. A comment that restates the identifier — "Foo is Foo", "Get gets" — passes a presence check and tells a reader nothing, so this rejects it: a doc comment must say something the name does not already say. That is the difference between documentation and a lint-satisfying ritual.

Generated files are skipped. Their documentation is written once, in the generator, and checking every emitted copy of it would measure the same sentence a thousand times.