checkdoc

command module
Version: v0.0.0-...-a1272c1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 15, 2022 License: BSD-2-Clause Imports: 10 Imported by: 0

README

checkdoc

Issue Tracker Docs Chat License

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.

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL