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

File: $1

Read the file. Identify all public functions, methods, types, and interfaces without JSDoc.
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.

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
Apply all comments to the file.

Más de este repositorio

mismo repositorio

Analyzes the current session's token usage, pinpoints where tokens were wasted, and produces concrete optimization actions

Generates API documentation from route definitions (Express, Fastify, Hono, etc.)

Adds caching to expensive operations - Redis, in-memory, HTTP cache headers

Staged değişiklikleri analiz edip Conventional Commits formatında commit mesajı oluşturur

Reports cyclomatic complexity hotspots and refactoring suggestions

Finds unused functions, variables, exports, and dependencies across the codebase

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

File: $1

Read the file. Identify all public functions, methods, types, and interfaces without JSDoc.
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.

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
Apply all comments to the file.