code-comment-guidelines

Redundant comments restate obvious code behavior without adding clarity. This Skill detects comments that merely echo what the code already expresses, then guides you to either remove them or refactor the code itself for better readability, reducing noise in your codebase.

JSDoc provides structured API documentation for exported functions and classes. This Skill ensures all public APIs in TypeScript and JavaScript include JSDoc blocks, automatically flagging undocumented exports and suggesting comment templates that follow industry standards.

Extract complex logic into well-named functions to make intent self-evident, reducing reliance on explanatory comments. This Skill recommends refactoring opportunities where meaningful function names replace lengthy prose, improving both maintainability and code review clarity.

Yes. This Skill scans modules in pull requests to detect inconsistent, redundant, and non-informative comments across TypeScript, JavaScript, and other languages, then auto-suggests corrections to enforce consistent commenting practices before merge.

This Skill applies comment guidelines across multiple languages with emphasis on TypeScript and JavaScript, where JSDoc for public APIs is prioritized. It addresses redundancy and refactoring opportunities in any language, adapting enforcement rules to language-specific conventions.

Non-informative comments state the obvious—like `i++` followed by `increment i`—or lack context about intent and decisions. This Skill flags these and distinguishes them from valuable comments that explain why code exists, trade-offs made, or edge cases handled.