Help us shape the future of Go! Take the 2026 Go Developer Survey

lint-comments

command
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Sep 29, 2026 License: MPL-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Comment-style gate for CLAUDE.md's code-comment rules. Flags overlong comment blocks, multi-line comments inside a function body, and banned phrases: PR/issue references, historical narration, and links to gitignored maintainer docs. Run via `task lint:comments`.

A doc comment that's genuinely reference data (a wire contract, a JSON schema) is exempt from the length check if one of its lines, stripped of the marker, reads exactly "lint:allow-long-comment", placed last so it doesn't become the godoc synopsis. There's no such exemption inside a function body: those are capped at one line, always.

Jump to

Keyboard shortcuts

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