documenting-code-comments
CommunityGuidelines to write purposeful, WHY-focused comments.
Authorthird774
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides standards for writing self-documenting code and best practices for inline comments, ensuring comments explain WHY rather than WHAT and reducing comment drift.
Core Features & Use Cases
- Commenting Guidelines: When to write or avoid comments, and the right style.
- Comment Formatting: JSDoc/TSDoc usage for public APIs; TODO formatting.
- Audit & Refactor: Helps audits by ensuring code remains self-documenting and maintainable.
Quick Start
Apply guidelines during code reviews or audits to improve inline documentation without overburdening the codebase.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: documenting-code-comments Download link: https://github.com/third774/dotfiles/archive/main.zip#documenting-code-comments Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.