global-commenting

name

Global Commenting

description

Write self-documenting code with minimal, helpful comments that explain large sections of logic without cluttering the codebase. Use this skill when writing code comments, documenting complex logic, reviewing whether comments are needed, writing function documentation, explaining non-obvious code sections, ensuring code clarity through naming and structure, avoiding temporary or change-related comments, keeping comments evergreen and future-relevant, or deciding between adding comments versus refactoring for clarity. Apply this skill when writing or reviewing any code file to ensure comments add value without creating noise, and that code is primarily self-explanatory through clear naming and structure.

Global Commenting

When to use this skill

• When writing or reviewing code comments in any file
• When documenting complex logic or algorithms that need explanation
• When deciding whether to add a comment or refactor for clarity
• When explaining non-obvious code sections or business logic
• When writing function or class documentation
• When ensuring code is self-documenting through clear naming and structure
• When removing outdated or unnecessary comments
• When avoiding comments that speak to recent changes or temporary fixes
• When keeping comments concise, minimal, and evergreen
• When reviewing code to ensure comments are helpful and relevant
• When balancing between commenting and writing self-explanatory code

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