playbooks

home / skills / jeremylongshore / claude-code-plugins-plus-skills / jsdoc-comment-generator

jsdoc-comment-generator skill

/skills/17-technical-docs/jsdoc-comment-generator

This skill helps you generate production-ready jsdoc comments and configurations for API docs and architecture guides, following best practices.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill jsdoc-comment-generator

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.2 KB
---
name: "jsdoc-comment-generator"
description: |
  Generate jsdoc comment generator operations. Auto-activating skill for Technical Documentation.
  Triggers on: jsdoc comment generator, jsdoc comment generator
  Part of the Technical Documentation skill category. Use when working with jsdoc comment generator functionality. Trigger with phrases like "jsdoc comment generator", "jsdoc generator", "jsdoc".
allowed-tools: "Read, Write, Edit, Bash(cmd:*), Grep"
version: 1.0.0
license: MIT
author: "Jeremy Longshore <[email protected]>"
---

# Jsdoc Comment Generator

## Overview

This skill provides automated assistance for jsdoc comment generator tasks within the Technical Documentation domain.

## When to Use

This skill activates automatically when you:
- Mention "jsdoc comment generator" in your request
- Ask about jsdoc comment generator patterns or best practices
- Need help with technical documentation skills covering api docs, user guides, architecture docs, and documentation automation.

## Instructions

1. Provides step-by-step guidance for jsdoc comment generator
2. Follows industry best practices and patterns
3. Generates production-ready code and configurations
4. Validates outputs against common standards

## Examples

**Example: Basic Usage**
Request: "Help me with jsdoc comment generator"
Result: Provides step-by-step guidance and generates appropriate configurations


## Prerequisites

- Relevant development environment configured
- Access to necessary tools and services
- Basic understanding of technical documentation concepts


## Output

- Generated configurations and code
- Best practice recommendations
- Validation results


## Error Handling

| Error | Cause | Solution |
|-------|-------|----------|
| Configuration invalid | Missing required fields | Check documentation for required parameters |
| Tool not found | Dependency not installed | Install required tools per prerequisites |
| Permission denied | Insufficient access | Verify credentials and permissions |


## Resources

- Official documentation for related tools
- Best practices guides
- Community examples and tutorials

## Related Skills

Part of the **Technical Documentation** skill category.
Tags: documentation, markdown, api-docs, readme, technical-writing

Overview

This skill automates generation of JSDoc comments to improve code documentation quality and consistency. It produces ready-to-use JSDoc blocks, suggests parameter and return types, and enforces common documentation patterns. Use it to speed up documentation, reduce review cycles, and maintain uniform API docs across projects.

How this skill works

The skill parses JavaScript or TypeScript function and class signatures, extracts parameters, return values, and types, then generates JSDoc comment blocks following common conventions. It can validate generated comments against standards, suggest improvements, and output production-ready snippets for insertion into source files. Triggers activate when requests mention jsdoc comment generator or related phrases.

When to use it

  • You need consistent JSDoc for functions, classes, or modules across a codebase
  • Preparing API documentation or automated docs generation (e.g., for typed or untyped code)
  • Onboarding contributors to ensure documentation standards are followed
  • Automating code reviews to detect missing or incomplete JSDoc blocks
  • Generating examples and descriptions for public or internal libraries

Best practices

  • Include clear one-line summaries and longer descriptions when behavior is non-trivial
  • Document parameter names, types, optionality, and default values explicitly
  • Use @returns (or @return) with precise types and descriptions for side effects or promises
  • Keep comments up to date with code changes; integrate generation into CI checks
  • Prefer TypeScript types when available and mirror them in JSDoc for untyped code

Example use cases

  • Auto-generate JSDoc blocks for all functions in a legacy JavaScript module before publishing docs
  • Create standardized comments for a new API surface during feature development
  • Validate and fill missing documentation as part of a pre-merge CI pipeline
  • Produce example parameter descriptions and usage snippets for README or API site
  • Convert TypeScript signatures into JSDoc for mixed-code repositories

FAQ

Does the generator infer types for untyped JavaScript?

It attempts to infer common types from code patterns and default values but recommends manual review for ambiguous cases.

Can this integrate with CI to enforce documentation coverage?

Yes. You can run the generator as a step in CI to fail on missing or invalid JSDoc and produce suggested fixes.