用途:审计代码注释与 docstring 质量,通用任意技术栈。主要能力:按 6 类检查——1) 注释解释 WHY 而非显而易见的 WHAT;2) 注释密度目标 15-20%;3) 禁止内容(日期、作者名、历史说明、注释中的代码示例);4) Docstrings 与函数签名、参数、返回类型一致;5) 时效性,注释与当前代码行为一致;6) 遗留清理,无无上下文 TODO、无注释掉的代码、无废弃说明。每类给出 X/10 评分并汇总。用法:用户可直接调用做注释质量评审,或由 ln-100-documents-pipeline 在 Phase 5(auditComments=true)调用。流程为扫描源文件(自动识别技术栈)、提取行内注释与 docstring/JSDoc、执行 6 类审计、评分、上下文校验后过滤、输出报告。上下文校验会加载 shared/references/context_validation.md,对 HIGH/MEDIUM 发现应用 ADR/计划覆盖规则;密度按路径分类调整目标(test/tests 2-10%,infra/config/ci 5-15%,business/domain/services 15-25%),docstring 占比超 50% 时单独计算行内密度;WHY-not-WHAT 在 McCabe 复杂度>15 或 domain/business 目录下允许 WHAT 注释。评分加载 shared/references/audit_scoring.md,严重度映射:作者名/日期为 CRITICAL,注释掉的代码块与过期注释为 HIGH,明显 WHAT 注释与密度偏差>5% 为 MEDIUM,轻微密度偏差为 LOW。输出含合规评分表、Critical Findings(file:line、类别、修复建议)与推荐动作表。限制:路径相对 skills 仓库根目录;规则文件不得修改以让违规通过,应改代码;注释与代码冲突时以代码为准。版本 3.0.0。
ln-610-code-comments-auditor
测试与质量
更新于 10-16 06:23