ln-613-code-comments-auditor

To audit code comments and docstrings, run an auditor that analyzes inline comments across your codebase to evaluate clarity, consistency, and compliance. It generates a Markdown report with severity, file and line location, and actionable recommendations for each violation.

Code comment quality evaluation assesses six quality categories, analyzing inline comments and docstrings for WHY versus WHAT context, density, and freshness. It reports findings with specific severity levels and locations to improve maintainability.

Yes, you can audit code comments across any tech stack. The auditor applies language-agnostic analysis to inline comments and docstrings to evaluate clarity, consistency, and compliance without requiring specific framework dependencies.

You generate a code comment findings report by running the auditor and configuring an output path. It produces a structured Markdown file containing severity, file and line locations, and actionable recommendations for each identified violation.

Common code comment issues include lacking WHY versus WHAT explanations, poor density, and staleness or lack of freshness. The auditor evaluates these across six quality categories to identify compliance violations and recommend improvements.

You integrate code comment auditing into a team coordinator workflow by running it within the Ln-610 coordinator workflow. This coordinates comment quality and compliance findings across teams to improve overall codebase maintainability.