Global commenting skills eis its global commenting

Skill bg-szy/TOP-SKILLS/skills/marketplace/global-commenting__skills-eis-its-global-commenting

Write self-documenting code with minimal, evergreen comments that explain complex logic without describing recent changes or temporary fixes. Use this skill when writing code comments, documentation strings, explaining complex algorithms, clarifying business logic, or deciding whether code needs comments. Apply when working with any source code files where comments or documentation might be added, ensuring comments remain relevant, helpful, and focused on explaining why rather than what the code does, while preferring clear code structure and naming over excessive commenting.From its SKILL.md

Install

npx -y skills add bg-szy/TOP-SKILLS --skill global-commenting__skills-eis-its-global-commenting

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.7 KB, 206 tokens by cl100k_base, as published. Nobody here has run it

Global Commenting

When to use this skill

When writing comments in any programming language
When deciding whether code needs explanatory comments
When documenting complex algorithms or business logic
When explaining non-obvious code decisions or workarounds
When writing docstrings or function documentation
When refactoring code to make it more self-explanatory
When reviewing existing comments for relevance and clarity
When removing outdated or temporary comments
When choosing between adding a comment vs improving code clarity
When explaining why certain approaches were chosen
When working with any source code files that may contain comments
When documenting APIs, functions, or class interfaces
When ensuring comments are evergreen and future-proof

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

What ships with it: 1 file

10.0 KB alongside SKILL.md