comment-analyzer

Name: comment-analyzer
Availability: InStock
Author: ngx-signal-forms

Analyze code comments for accuracy and maintainability during code reviews.

3|2|Updated Oct 9, 2025

Search Tags:#maintainability #analysis #code-review #comment #code-comments #technical-debt #documentation-quality

Ready to run

npx skills add https://github.com/ngx-signal-forms/ngx-signal-forms --skill comment-analyzer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: comment-analyzer
Source: https://github.com/ngx-signal-forms/ngx-signal-forms/tree/main/.github/skills/pr-toolkit/comment-analyzer
Command: npx skills add https://github.com/ngx-signal-forms/ngx-signal-forms --skill comment-analyzer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Codebases often accumulate misleading or outdated comments that diverge from implementation, creating confusion and technical debt. The comment-analyzer helps maintain long-term health by auditing comments for accuracy, completeness, and alignment with code behavior.

Core Features & Use Cases

Verify that comments accurately reflect function signatures, behavior, and side effects.
Detect comment rot and flag outdated guidance during code reviews and PRs.
Provide actionable remediation suggestions to improve documentation quality and maintainability.

Quick Start

Review the comments across touched files in a pull request to verify accuracy, completeness, and long-term maintainability.

Frequently Asked Questions about comment-analyzer

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

FAQPage Schema

How do I detect stale or misleading code comments during a pull request review?▼

Detect misleading code comments during a pull request by analyzing touched files to verify factual alignment between comments and implementation, flagging outdated guidance, and providing actionable remediation suggestions.

What is code comment rot and how does it impact maintainability?▼

Code comment rot occurs when documentation diverges from implementation over time, creating confusion and technical debt. Auditing comments for accuracy and completeness helps maintain long-term codebase health and maintainability.

Can I audit documentation quality across an entire module's functions?▼

Yes, you can audit documentation quality across functions and modules by verifying that comments accurately reflect function signatures, behavior, and side effects, ensuring long-term alignment with code behavior.

What's the best way to verify that function comments match actual behavior and side effects?▼

The best way to verify function comments match behavior is to analyze factual alignment between documentation and code, detecting misleading or outdated guidance and providing remediation steps to improve documentation quality.

When should I audit code comments for documentation rot?▼

You should audit code comments for documentation rot during code reviews, PR reviews, and general codebase auditing to catch misleading or outdated comments before they create confusion and technical debt.