---
name: Global Commenting
description: Write minimal, helpful code comments that explain why rather than what, prioritizing self-documenting code with clear structure and naming. Use this skill when adding comments to code, documenting complex logic, explaining non-obvious decisions or algorithms, writing function or class documentation, creating inline explanations for large sections of code, removing outdated or unhelpful comments, refactoring code to be more self-explanatory, or ensuring comments remain evergreen and relevant long-term. Use across all programming languages when deciding whether and how to comment code, including when writing or reviewing .js, .ts, .py, .java, .go, .rs, .rb, .php, .jsx, .tsx, .vue files or any other code files.
---

## When to use this skill

- When adding comments to code
- When documenting complex logic or algorithms
- When explaining non-obvious design decisions or workarounds
- When writing function, class, or module documentation
- When creating inline explanations for large sections of code
- When removing outdated, redundant, or unhelpful comments
- When refactoring code to be more self-explanatory and reduce comment needs
- When ensuring comments explain "why" rather than "what"
- When reviewing code to ensure comments remain evergreen and relevant
- When deciding whether a comment is necessary or if clearer code would be better
- When writing or reviewing any code file in any programming language
- When avoiding comments about recent changes, temporary fixes, or time-sensitive information

# 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](../../../agent-os/standards/global/commenting.md)