JSDoc/Docstring Generator

Version: 1.0 Added: Jan 21, 2026

Description

Automatically generates documentation comments for functions, classes, and modules. Supports JSDoc, Python docstrings, JavaDoc, and other documentation formats.

Code

Skill Code

Generate documentation including:
- Brief description
- @param with types and descriptions
- @returns with type and description
- @throws "keyword">for possible exceptions
- @example with usage code
- @deprecated "keyword">if applicable

Usage Examples

Examples

User: add docs to src/utils/formatDate.js

Claude: *adds JSDoc*
```javascript
/**
 * Formats a date into a human-readable string
 * @param {Date|string|number} date - The date to format
 * @param {string} [format="YYYY-MM-DD"] - Output format
 * @returns {string} Formatted date string
 * @throws {TypeError} If date is invalid
 * @example
 * formatDate(new Date(), "MM/DD/YYYY") // "01/21/2026"
 */
```

Installation

Add the following to your CLAUDE.md file (project root or ~/.claude/CLAUDE.md for global):

CLAUDE.md

# JSDoc/Docstring Generator

Generate documentation including:
- Brief description
- @param with types and descriptions
- @returns with type and description
- @throws for possible exceptions
- @example with usage code
- @deprecated if applicable

Comments (0)

No comments yet. Be the first to share your thoughts!