skills.rest
bcmcpher
bcmcpherCOMMUNITY
Explore all skills by this author →
𝕏@bcmcpherGitHub

comment-analyzer

Analyze code comments for factual accuracy against implementation.

1|Updated Feb 25, 2026
Search Tags:#maintainability#static-analysis#code-review#code-comments#technical-debt#documentation-quality#comment-analysis
One-click install
npx skills add https://github.com/bcmcpher/my-skills --skill comment-analyzer-bcmcpher
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: comment-analyzer
Source: https://github.com/bcmcpher/my-skills/tree/main/plugins/programming-tools/agents/comment-analyzer
Command: npx skills add https://github.com/bcmcpher/my-skills --skill comment-analyzer-bcmcpher

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze code comments for factual accuracy, completeness, and long-term maintainability to prevent misleading documentation and technical debt.

Core Features & Use Cases

  • Factual accuracy checks that comments align with function signatures, behavior, and referenced types.
  • Completeness ensures critical preconditions, side effects, error handling, and rationale are documented.
  • Long-term value highlights outdated or redundant comments and suggests meaningful improvements.
  • Use cases include code reviews, documentation updates, and PR checkpoints where comments may drift from implementation.

Quick Start

Provide a code snippet and its comments for analysis to assess alignment and improve maintainability.

Frequently Asked Questions about comment-analyzer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if code comments match the actual implementation?▼

Comment rot occurs when code comments drift from the actual implementation, creating misleading documentation and technical debt. Analyzing comments for factual accuracy and completeness guards against this drift by ensuring alignment with current behavior.

How do I prevent comment rot in my codebase?▼

Comment rot occurs when code comments drift from the actual implementation, creating misleading documentation and technical debt. Analyzing comments for factual accuracy and completeness guards against this drift by ensuring alignment with current behavior.

How do I validate code documentation quality during a pull request review?▼

Validating code documentation quality during a code review involves checking comments for factual accuracy, completeness, and long-term value. Analyze snippets to ensure preconditions, side effects, and error handling are documented and match the implementation.

Can I use static analysis to detect outdated or redundant comments?▼

Static analysis can detect outdated or redundant comments by highlighting long-term maintainability issues. It validates factual accuracy against function signatures and referenced types, suggesting meaningful improvements to prevent technical debt.

What should be included in code comments to ensure long-term maintainability?▼

For long-term maintainability, code comments should document critical preconditions, side effects, error handling, and rationale. Analyzing comments ensures these elements are complete and aligned with the actual implementation behavior.

When should I not use automated comment analysis for technical debt?▼

Automated comment analysis for technical debt is less effective when code lacks initial documentation or contains trivial logic. It is best applied across functions, methods, and modules during code reviews where meaningful comments may drift from implementation.

Related Skills

Explore More Software Engineering Skills→
igor1309igor1309

doc-drift-audit

Detect factual mismatches between markdown documentation and code in a repository.

Community
Advanced
gaoqiongxiegaoqiongxie
1

codebase-inventory-audit

Audit codebases to detect orphan code, duplicate logic, and documentation gaps.

Community
Intermediate
nicolanoviellnicolanoviell
2

code-review

Review code changes for bugs, style issues, and best practices.

Community
Intermediate
d-o-hubd-o-hub
11

analysis-dimensions

Detect duplicate code blocks and map architectural structure across a codebase.

Community
Intermediate