global-commenting
Write minimal, helpful code comments that explain logic without cluttering the codebase. Use this skill when deciding whether to add comments to code. Use this skill when writing self-documenting code with clear naming and structure. Use this skill when adding concise comments to explain complex logic sections. Use this skill when avoiding comments that describe recent changes or temporary fixes. Use this skill when ensuring comments remain evergreen and relevant long-term. Use this skill when preferring code clarity over excessive commenting. Use this skill when documenting code in any file throughout the project.
SKILL.md
| Name | global-commenting |
| Description | Write minimal, helpful code comments that explain logic without cluttering the codebase. Use this skill when deciding whether to add comments to code. Use this skill when writing self-documenting code with clear naming and structure. Use this skill when adding concise comments to explain complex logic sections. Use this skill when avoiding comments that describe recent changes or temporary fixes. Use this skill when ensuring comments remain evergreen and relevant long-term. Use this skill when preferring code clarity over excessive commenting. Use this skill when documenting code in any file throughout the project. |
name: Global Commenting description: Write minimal, helpful code comments that explain logic without cluttering the codebase. Use this skill when deciding whether to add comments to code. Use this skill when writing self-documenting code with clear naming and structure. Use this skill when adding concise comments to explain complex logic sections. Use this skill when avoiding comments that describe recent changes or temporary fixes. Use this skill when ensuring comments remain evergreen and relevant long-term. Use this skill when preferring code clarity over excessive commenting. Use this skill when documenting code in any file throughout the project.
Global Commenting
When to use this skill
- When deciding whether code needs comments or can be self-explanatory
- When writing code with clear structure and naming that explains itself
- When adding concise comments to explain complex logic or algorithms
- When reviewing existing comments to ensure they are still relevant
- When avoiding comments that describe recent changes or temporary states
- When ensuring comments are evergreen and will remain valuable over time
- When removing outdated or unnecessary comments during code maintenance
- When documenting code across any language or file type in the project
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