home/categories/technical-docs/imkdw-imkdw-dev-claude-skills-global-commenting-skill-md
technical-docsdocumentation

global-commenting

Write appropriate code comments following the project's self-documenting code philosophy. Use this skill when deciding whether to add comments to code, when writing JSDoc comments for public APIs, when documenting complex business logic, or when maintaining existing code comments. This includes avoiding comments that describe recent changes or temporary fixes, writing evergreen informational comments, using clear naming instead of comments where possible, and adding minimal but helpful comments for large code sections. Apply when writing any TypeScript code and deciding on documentation approach.

imkdw
maintainer
imkdw
更新於 1/19/2026
星標
1
分支
0
quick start

Installation and usage

Write appropriate code comments following the project's self-documenting code philosophy. Use this skill when deciding whether to add comments to code, when writing JSDoc comments for public APIs, when documenting complex business logic, or when maintaining existing code comments. This includes avoiding comments that describe recent changes or temporary fixes, writing evergreen informational comments, using clear naming instead of comments where possible, and adding minimal but helpful comments for large code sections. Apply when writing any TypeScript code and deciding on documentation approach.

安裝
$ install --globalskills.sh
使用

安裝後,您可以透過在終端機執行以下指令來使用此技能:

skills use global-commenting