Agent skill

Global Commenting

Write self-documenting code with minimal, helpful comments that explain complex logic without documenting temporary changes or fixes. Use this skill when adding comments to code, documenting functions or classes, or explaining complex algorithms. When writing or editing any code file that may benefit from explanatory comments. When reviewing existing comments to ensure they remain evergreen and relevant. When deciding whether code needs comments or if better naming and structure would be clearer. This skill applies to all code files in any programming language including `.js`, `.ts`, `.py`, `.rb`, `.java`, `.go`, `.php`, and others.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/global-commenting-dpietersz-pietersz-me

SKILL.md

Global Commenting

When to use this skill

  • When adding comments to any code file in any programming language
  • When documenting complex logic or algorithms that aren't immediately obvious
  • When writing or reviewing function/method documentation
  • When explaining large sections of code that perform non-trivial operations
  • When deciding whether to add a comment or refactor for clarity
  • When reviewing existing comments to remove outdated or temporary notes
  • When ensuring comments are evergreen and won't become stale
  • When avoiding comments about recent changes, fixes, or temporary workarounds
  • When prioritizing self-documenting code through clear naming and structure
  • When writing minimal, concise comments that add value

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

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results