Skip to content
Back to skills

Jsdoc

ASecurity

Adds JSDoc/TSDoc comments to all public functions and types in a file

  • 10 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added June 1, 2026
ai-agentstypescript

Security analysis

A100/100

Scanned June 1, 2026

npx -y skills add berkcangumusisik/claude-code-practices --skill jsdoc --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Jsdoc?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Jsdoc
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/berkcangumusisik-jsdoc/badge)](https://www.skillsdirectory.com/skills/berkcangumusisik-jsdoc)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: jsdoc
description: Adds JSDoc/TSDoc comments to all public functions and types in a file
argument-hint: <file-path>
user-invocable: true
allowed-tools: Read Edit
effort: low
---

## Add JSDoc Comments

File: **$1**

1. Read the file. Identify all public functions, methods, types, and interfaces without JSDoc.

2. For each, write a JSDoc comment that includes:
   - `@description` - what it does (one sentence)
   - `@param` - each parameter with type and description
   - `@returns` - return value description
   - `@throws` - if it can throw, what and when
   - `@example` - a short usage example for non-obvious functions

Follow TSDoc format (`/** */`) for TypeScript files.

3. Rules:
   - Don't state the obvious: `// Gets the user` → write *why/when* to use it
   - Private/internal functions: add a brief comment only if logic is non-obvious
   - Don't add params that are self-explanatory single-letter generics

4. Apply all comments to the file.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…