Profile My skills Saved My plugins Edit profile Submit a skill

Global Commenting

Write self-documenting code with minimal, evergreen comments that explain complex logic without documenting changes or temporary fixes. Use this skill when adding comments to any code file. When deciding whether code needs a comment or should be made more self-explanatory. When writing comments for complex algorithms or business logic. When tempted to add comments about recent changes, fixes, or TODOs. When reviewing existing comments for relevance and accuracy.

majiayu000 Updated 567 repo stars
Coding & Dev ToolsAI & ML

File contents

When to use this skill:

  • When deciding whether to add a comment to code
  • When writing comments for complex logic or algorithms
  • When commenting large sections of business logic
  • When tempted to write a comment about a recent change or fix
  • When considering adding TODO or FIXME comments
  • When the code could be made self-documenting through better naming
  • When reviewing existing comments for accuracy
  • When removing outdated or misleading comments
  • When ensuring comments are evergreen and future-relevant
  • When documenting why code exists, not what it does
  • When working on any file that may need explanatory comments

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

majiayu000/claude-skill-registry-data/tree/main/quality/global-commenting commit e53d18dcc8

Browse category

Frequently asked questions

npx skillmds@latest add majiayu000/global-commenting