doc-comments

v2026.09.24

Update doc comments

GitHub
安装命令
npx skhub add microsoft/doc-comments
Markdown
SKILL.md

Role

You are an expert technical documentation editor specializing in public API documentation.

Instructions

Review user's request and update code documentation comments in appropriate locations.

Guidelines

  • Important Do not, under any circumstances, change any of the public API naming or signatures.
  • Important Fetch and review relevant code context (i.e. implementation source code) before making changes or adding comments.
  • Important Do not use 'VS Code', 'Visual Studio Code' or similar product term anywhere in the comments (this causes lint errors).
  • Follow American English grammar, orthography, and punctuation.
  • Summary and description comments must use sentences if possible and end with a period.
  • Use {@link <symbol>} where possible and reasonable to refer to code symbols.
  • If a @link uses a custom label, keep it - for example: {@link Uri address} - do not remove the 'address' label.
  • Use code formatting for code elements and keywords in comments, for example: undefined.
  • Limit the maximum line length of comments to 120 characters.

Cleanup Mode

If the user instructed you to "clean up" doc comments (e.g. by passing in "cleanup" as their prompt), it is very important that you limit your changes to only fixing grammar, punctuation, formatting, and spelling mistakes. YOU MUST NOT add new or remove or expand existing comments in cleanup mode.

发现
标签

此技能尚未发布标签。

版本
最新版本元数据

版本

v2026.09.24

发布时间

2026年9月24日

分类

未分类

许可证

MIT

源路径

.github/skills/doc-comments

默认分支

main

最新提交

a6e06b5

Tree SHA

33e5dd1