jsdoc

Standardize JavaScript and TypeScript code documentation with consistent JSDoc-style comments and API docs.

109|6|Updated Apr 15, 2021
One-click install
npx skills add https://github.com/rishighan/threetwo --skill jsdoc-rishighan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jsdoc
Source: https://github.com/rishighan/threetwo/tree/main/.claude/skills/jsdoc
Command: npx skills add https://github.com/rishighan/threetwo --skill jsdoc-rishighan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides developers in writing clear, consistent JSDoc-style comments and API documentation, reducing ambiguity and onboarding time.

Core Features & Use Cases

  • Guidelines for when to comment to explain why, not what.
  • Structured JSDoc blocks and API docs for classes, functions, and modules.
  • Use Case: Teams adopt unified documentation standards across a JavaScript/TypeScript codebase.

Quick Start

Document a sample function with a concise JSDoc block.

Frequently Asked Questions about jsdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write JSDoc comments for JavaScript functions to improve code readability?

Standardize JSDoc comments by using structured blocks that explain why code exists rather than what it does. This enforces consistent documentation practices across JavaScript and TypeScript modules, classes, and APIs to improve readability and onboarding.

What is the best way to standardize API documentation across a JavaScript and TypeScript codebase?

The best way to standardize API documentation is enforcing unified JSDoc practices across the codebase. Teams apply structured JSDoc blocks with guidelines, examples, and anti-patterns to modules, classes, and APIs to reduce ambiguity and onboarding time.

When do I need structured JSDoc blocks for modules and classes?

You need structured JSDoc blocks for modules and classes when onboarding new developers or maintaining complex APIs. Consistent JSDoc practices reduce ambiguity by explaining the purpose behind the code, ensuring clarity across JavaScript and TypeScript projects.

Does this JSDoc documentation approach work with both JavaScript and TypeScript projects?

Yes, this JSDoc documentation approach works with both JavaScript and TypeScript projects. It applies consistent commenting standards across modules, classes, and APIs in both languages to clarify code purpose and improve overall maintainability.

What are common JSDoc anti-patterns I should avoid when documenting code?

Common JSDoc anti-patterns to avoid include using comments to explain what the code does instead of why it exists. Following structured JSDoc guidelines with practical examples helps prevent these anti-patterns, ensuring documentation reduces ambiguity rather than adding noise.