code-comment-guidelines
CommunityEnforce clean code comments: explain why.
Authorhiro0218
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill enforces meaningful commenting practices, guiding developers to avoid redundant comments, apply JSDoc to public APIs, and prefer refactoring over excessive commentary.
Core Features & Use Cases
- Redundant Comment Detection: flags comments that restate obvious code behavior.
- Public API Documentation: ensures exported APIs have JSDoc.
- Refactoring Guidance: suggests extracting logic into well-named functions to reduce comments.
- Use Case: In a PR, scan a module like src/utils/math.ts to improve comments and add JSDoc.
Quick Start
Ask the skill to review the comments in a file, for example: "Review src/utils/math.ts comments for redundancy and JSDoc coverage."
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: code-comment-guidelines Download link: https://github.com/hiro0218/b.0218.jp/archive/main.zip#code-comment-guidelines Please download this .zip file, extract it, and install it in the .claude/skills/ directory.