| name | Global Commenting |
| description | Write minimal, evergreen code comments that explain complex logic sections while prioritizing self-documenting code through clear naming and structure. Use this skill when writing or reviewing code comments in any programming language. Apply when adding comments to explain large sections of complex logic, algorithm implementations, or non-obvious code behavior. Use when ensuring code is self-documenting through clear variable names, function names, and code structure. Apply when removing or avoiding comments that describe temporary changes, recent fixes, or time-sensitive information that will become outdated. Use when refactoring code to be more self-explanatory and reducing the need for explanatory comments. Apply when writing comments that provide lasting value and context for future developers, focusing on the "why" behind complex decisions rather than the "what" of obvious code. |
When to use this skill:
- When writing code comments in any programming language
- When explaining complex logic, algorithms, or non-obvious code behavior
- When adding concise comments to clarify large sections of code
- When ensuring code is self-documenting through clear naming and structure
- When reviewing existing comments for relevance and value
- When removing comments about temporary changes, fixes, or time-sensitive information
- When avoiding over-commenting obvious code
- When refactoring code to reduce the need for explanatory comments
- When writing evergreen comments that remain relevant long-term
- When documenting the "why" behind complex decisions
Global Commenting
This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle global commenting.
Instructions
For details, refer to the information provided in this file: global commenting