Global Commenting

Write self-documenting code with minimal, evergreen comments that explain complex logic rather than obvious implementations or recent changes. Use this skill when writing code in any programming language; when deciding whether to add comments to explain logic; when writing comments that clarify complex algorithms or non-obvious reasoning; when documenting large sections of code; when avoiding comments that speak to recent or temporary changes or fixes; when prioritizing self-documenting code through clear structure and naming; when writing JSDoc, TSDoc, Python docstrings, or similar documentation comments; when refactoring code to be more self-explanatory; or when maintaining comment quality across the codebase. Use when this capability is needed.

tomevault-io 3967a54 2 files · 2.5 KB Updated

File contents

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.

When to use this skill

  • When writing self-documenting code through clear structure and naming
  • When adding concise, minimal comments to explain large sections of logic
  • When avoiding comments about recent or temporary changes or fixes
  • When ensuring comments are evergreen and relevant far into the future
  • When documenting complex algorithms or non-obvious reasoning
  • When writing function documentation (JSDoc, TSDoc, docstrings)
  • When refactoring code to be more self-explanatory
  • When maintaining comment quality across TypeScript, JavaScript, Python, Ruby, or any codebase

Instructions

For details, refer to the information provided in this file: global commenting


Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/shynlee04--idumb-v2--global-commenting commit 3967a542d4

Frequently asked questions

npx skillmds@latest add tomevault-io/global-commenting