checkdoc

README

checkdoc

The checkdoc command scans Go packages for comment and documentation related lints. Currently the tool checks for:

• Packages that are missing documentation comments
• Exported identifiers that are missing documentation comments
• Malformed or missing canonical import comments
• Missing file header comments

If you'd like to contribute to the project, see CONTRIBUTING.md.

To use checkdoc first install it:

go install mellium.im/checkdoc@latest

Then run checkdoc -help to find out more about using it. For example, to run the file header check lint across an entire module:

checkdoc -fileheader.pattern='-' ./... <<EOF
Copyright \d\d\d\d The Mellium Contributors\.
Use of this source code is governed by the BSD 2-clause
license that can be found in the LICENSE file\.
EOF

License

The package may be used under the terms of the BSD 2-Clause License a copy of which may be found in the file "LICENSE".

Documentation

Overview

The checkdoc command analyzes Go source code to ensure package level docs are present.