Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Update public API doc comments v1.0.0

Use this resource to update the documentation comments of a public API

New

  • 560 downloads
  • 153 likes
  • 127 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install public-api-doc-comments

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent first reads the implementation, then adds or fixes comments without touching the names or signatures of the public API. You get comments checked against the code.

Mostly picked by

Updated November 2, 2026

Card for the “Update public API doc comments” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: role and instructions of the documentation editor
  • SKILL.md: rules protecting the public API
  • SKILL.md: cleanup mode for comments

Good fit for

  • You document a public library before a release
  • Comments went stale after a refactoring

Not for

    Tags

    • documentation
    • public api
    • comments
    • code

    About

    You say

    “Update the doc comments of the public cache class after the refactor.”

    Card for the “Update public API doc comments” skill

    Skill published by microsoft under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to update the documentation comments of a public API
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md1.5 KB

    Origin and licence

    Listed unmodified

    Author
    microsoft
    Source
    github.com/microsoft/vscode/tree/c237f99ee87f8977a3e68b9ce797b8b8bd743201/.github/skills/doc-comments
    Licence
    MIT

    Notice

    « doc-comments » (microsoft, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.