global-commenting
编写最小化的、永不过时的代码注释,解释复杂逻辑而不记录明显的行为或临时更改。向 PHP 文件、TypeScript/JavaScript 文件或任何代码文件添加注释、记录复杂算法或业务逻辑、添加 PHPDoc 块或 JSDoc 注释、使用清晰的命名编写自解释代码或审查现有注释的相关性和必要性时使用此技能。重点关注通过清晰的结构和命名使代码自解释,而不是过度依赖注释。
📖 中文导读:编写最小化的、永不过时的代码注释,解释复杂逻辑而不记录明显的行为或临时更改。向 PHP 文件、TypeScript/JavaScript 文件或任何代码文件添加注释、记录复杂算法或业务逻辑、添加 PHPDoc 块或 JSDoc 注释、使用清晰的命名编写自解释代码或审查现有注释的相关性和必要性时使用此技能。重点关注通过清晰的结构和命名使代码自解释,而不是过度依赖注释。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: Global Commenting description: Write minimal, evergreen code comments that explain complex logic without documenting obvious behavior or temporary changes. Use this skill when adding comments to PHP files, TypeScript/JavaScript files, or any code files, when documenting complex algorithms or business logic, when adding PHPDoc blocks or JSDoc comments, when writing self-documenting code with clear naming, or when reviewing existing comments for relevance and necessity. Focus on keeping code self-explanatory through clear structure and naming rather than relying heavily on 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.
When to use this skill
- When adding comments to PHP, TypeScript, JavaScript, or any code files
- When documenting complex business logic or algorithms that aren't immediately obvious
- When writing PHPDoc blocks for PHP classes, methods, or functions
- When adding JSDoc or TSDoc comments for TypeScript/JavaScript functions
- When explaining the "why" behind non-obvious code decisions
- When refactoring code to be more self-documenting and reduce comment necessity
- When reviewing existing comments to ensure they're evergreen and still relevant
- When removing outdated comments about temporary fixes or recent changes
- When documenting complex array shapes or data structures in PHPDoc
- When choosing between adding a comment vs. refactoring for clarity
Instructions
For details, refer to the information provided in this file: global commenting