global-commenting

dpietersz 的头像作者 dpietersz

编写自我记录的代码,使用最少、有用的注释解释逻辑而不是变化。在为TypeScript文件添加注释、编写JSDoc文档、决定代码是否需要注释或审查现有注释时使用此技能。在编写n8n节点代码、辅助函数或任何需要平衡清晰度与注释密度的代码时应用。

📖 中文导读:编写自我记录的代码,使用最少、有用的注释解释逻辑而不是变化。在为TypeScript文件添加注释、编写JSDoc文档、决定代码是否需要注释或审查现有注释时使用此技能。在编写n8n节点代码、辅助函数或任何需要平衡清晰度与注释密度的代码时应用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: Global Commenting description: Write self-documenting code with minimal, helpful comments that explain logic rather than changes. Use this skill when adding comments to TypeScript files, writing JSDoc documentation, deciding whether code needs commenting, or reviewing existing comments. Apply when writing n8n node code, helper functions, or any code where you need to balance clarity with comment density.

When to use this skill:

  • When deciding whether to add comments to code
  • When writing JSDoc documentation for functions
  • When adding inline comments to explain complex logic
  • When reviewing or cleaning up existing comments
  • When writing self-documenting code with clear naming
  • When explaining large sections of code logic
  • When avoiding comments that describe temporary changes or fixes
  • When balancing code clarity with appropriate comment density

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