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.
Click to show internal directories.
Click to hide internal directories.