返回 Skill 列表
extension
分类: 开发与工程无需 API Key

global-commenting

编写简洁、持久的代码注释,解释复杂的逻辑,而不记录显而易见的行为或临时变更。在为PHP文件、TypeScript/JavaScript文件或其他任何代码文件添加注释时使用此技能;在文档化复杂的算法或业务逻辑时;在添加PHPDoc块或JSDoc注释时;在编写具有清晰命名的自描述代码时;或在审查现有注释的相关性和必要性时。重点通过清晰的结构和命名使代码本身易于理解,而不是过分依赖于注释。

person作者: jakexiaohubgithub

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