Skip to content
TrustedSkillsbeta
Back to all skills

Tsdoc Comments

Checked
marius-townhouse·vlatest·writing

Generates comprehensive TsDoc comments for your JavaScript code, improving documentation and maintainability.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add marius-townhouse/effective-typescript-skills --skill tsdoc-comments -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

marius-townhouse

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned marius-townhouse/effective-typescript-skills at d754db2077.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
d754db2077
Manifest
skills/tsdoc-comments/SKILL.md
Scanned
1 file, 214 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

The tsdoc-comments skill enables AI agents to generate, understand, and modify TypeScript documentation comments (TSDoc). It can automatically create JSDoc style comments for functions and classes, update existing comments based on code changes, and ensure consistency in comment formatting. This helps maintain clean, well-documented TypeScript projects.

When to use it

  • Automated Documentation: Generate initial TSDoc comments for a new TypeScript project or codebase.
  • Comment Updates: Automatically update documentation when function signatures or class structures change.
  • Code Review Assistance: Ensure consistent comment formatting and style across a team's code base during code reviews.
  • Refactoring Support: Update TSDoc comments to accurately reflect changes made during refactoring efforts.

Key capabilities

  • Generates JSDoc-style comments.
  • Updates existing documentation based on code modifications.
  • Maintains consistent comment formatting.

Example prompts

  • "Generate TSDoc comments for this function: function calculateSum(a: number, b: number): number { return a + b; }"
  • "Update the JSDoc comment to reflect the new parameter type in this function signature."
  • “Ensure all comments follow the team’s established style guide.”

Tips & gotchas

This skill is most effective when integrated into an automated build or code review process. It requires a TypeScript project as input and may need configuration to align with specific documentation styles.