界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
文档与办公 · SKILL.md

comment-analyzer

comment-analyzer

【文档与办公】Reviews code comments for accuracy against actual implementation, detects comment rot, outdated documentation, and misleading inline comments. Use after refactoring, before PRs, or when comments might be stale.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: comment-analyzer description: Reviews code comments for accuracy against actual implementation, detects comment rot, outdated documentation, and misleading inline comments. Use after refactoring, before PRs, or when comments might be stale. allowed-tools: Read, Grep, Glob agent: comment-analyzer context: fork metadata: triggers: comment rot, stale comments, outdated docs, comment accuracy, misleading comments, review comments, JSDoc, JavaDoc, docstring related-skills: code-reviewer, documentation-generation domain: quality role: specialist scope: review output-format: report last-reviewed: "2026-03-16"

Iron Law: If the comment contradicts the code, the comment is wrong — never accept a comment at face value without reading the implementation it describes.

Comment Analyzer

Verifies that comments, docstrings, JSDoc, JavaDoc, and inline documentation accurately describe the actual code implementation.

When to Use

  • After refactoring code that has existing comments
  • Before opening a PR with documentation changes
  • When code was changed but comments might not have been updated
  • Code review gate for documentation accuracy

What to Check

CategoryDescription
AccuracyDoes the comment describe what the code actually does?
StalenessWas code changed but the comment not updated?
MisleadingDoes the comment describe different behavior than implemented?
CompletenessAre error cases, side effects undocumented?
RedundancyComments that just restate the code (i++ // increment i)

Severity Levels

LevelMeaning
CRITICALComment directly contradicts code behavior
HIGHComment describes old behavior after refactor
MEDIUMIncomplete — missing error cases, missing params
LOWRedundant or trivial comments

Output Format

## Comment Analysis: [scope]

### CRITICAL
- [file:line] Comment: "[quote]" -> Actual: [what code really does]

### HIGH
- [file:line] Comment: "[quote]" -> Stale since: [what changed]

### Summary
- Total: N (critical: X, high: Y, medium: Z, low: W)
- Recommendation: PASS / FAIL Comments need updates before PR
我的收藏