CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

doc-comments

Update doc comments

54

Quality

68%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.github/skills/doc-comments/SKILL.md
SKILL.md
Quality
Evals
Security

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.

Repository

microsoft/vscode

Path

.github/skills/doc-comments/SKILL.md

Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.