AGENT SKILL

doc-comments

Update doc comments

License 许可
MIT
所属仓库
microsoft/vscode
最近更新
2026-11-11
Stars
★ 20w
Forks
4.4w

01 前言 Front Matter

name
doc-comments
description
Update doc comments
disable-model-invocation
true

02 资源文件 1

03 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.

04 同仓库更多 Skills

microsoft
microsoft/vscode

sweeper-query

Answer natural-language questions about the VS Code Sweeper's published issue index (index-<name>.json for microsoft/vscode and the enrolled family repos) — which issues are agent-ready to implement or plan, what the sweeper proposed for an assignee or area, whether the sweeper knows a report as a duplicate, the highest-value open bugs in a lane — and, for one issue, the review's full record (evidence with file citations, fix brief, proposed comment). Use ONLY when the request explicitly names the sweeper — "sweeper", "vscodesweeper", "sweeper-query", a sweeper verdict, record, brief or index, an agent-ready issue — or asks what "the sweeper" found, proposed or knows. Do NOT use for general questions about issues, duplicates, priorities or ranking that do not mention the sweeper. Read-only; discovery only.

★ 20w
microsoft
microsoft/vscode

update-skills

Create or update repository skills and instructions when major learnings are discovered during a session. Use when the user says "learn!", when a significant pattern or pitfall is identified, or when reusable domain knowledge should be captured for future sessions.

★ 20w
microsoft
microsoft/vscode

update-pr

Update the pull request for the current session. Use when the user wants to push new changes to an existing PR.

★ 20w
microsoft
microsoft/vscode

sync

Sync the current session branch with its upstream branch, or publish the current session branch to a remote. Use when the user asks to sync a branch, pull latest changes, rebase onto upstream, push current branch, publish branch, or set upstream.

★ 20w
microsoft
microsoft/vscode

sync-upstream

Update a stale session branch by rebasing onto the latest origin. Use when the upstream has moved significantly and the session needs to catch up, resolving conflicts by preserving upstream changes and adapting session work to fit.

★ 20w
microsoft
microsoft/vscode

merge

Merge changes from the topic branch to the merge base branch. Use when the user wants to merge their session's work back to the base branch.

★ 20w