skills.rest
jrodrigopuca
jrodrigopucaCOMMUNITY
Explore all skills by this author →
GitHub

using-jsdoc

Document JavaScript and TypeScript code with JSDoc comments.

Updated Feb 10, 2026
Search Tags:#typescript#documentation#javascript#code comments#jsdoc#api reference
One-click install
npx skills add https://github.com/jrodrigopuca/skills --skill using-jsdoc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: using-jsdoc
Source: https://github.com/jrodrigopuca/skills/tree/main/using-jsdoc
Command: npx skills add https://github.com/jrodrigopuca/skills --skill using-jsdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers create clear, maintainable, and discoverable code by generating professional JSDoc comments for JavaScript and TypeScript.

Core Features & Use Cases

  • Standardized Documentation: Apply JSDoc to functions, classes, types, and modules.
  • Improved Readability: Enhance code understanding for yourself and your team.
  • Tooling Integration: Enable IDE features like autocompletion and type checking.
  • Use Case: When you write a new function, use this Skill to automatically add comprehensive JSDoc comments explaining its purpose, parameters, and return values.

Quick Start

Add JSDoc documentation to the provided JavaScript function.

Frequently Asked Questions about using-jsdoc

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

FAQPage Schema
How do I write JSDoc comments for JavaScript functions?▼

Writing JSDoc comments for JavaScript functions involves applying standardized tag syntax to describe parameters, return types, and purpose, which enhances code readability and enables IDE autocompletion.

What is the best way to document TypeScript generics using JSDoc?▼

Documenting TypeScript generics using JSDoc requires utilizing specific type expressions and patterns to define generic parameters, ensuring accurate type checking and code discoverability within your TypeScript modules.

Does JSDoc work with TypeScript for type checking and IntelliSense?▼

Yes, JSDoc works with TypeScript to provide type checking and IntelliSense by utilizing type expressions and tags, allowing you to enforce type safety and improve code understanding without strictly using TypeScript syntax.

How do I generate API reference documentation from code comments?▼

You generate API reference documentation from code comments by structuring your JavaScript and TypeScript modules with standardized JSDoc tags, facilitating automated documentation generation and improving overall code discoverability.

Can I use JSDoc to document classes and modules in JavaScript?▼

Yes, you can use JSDoc to document classes and modules in JavaScript by applying specific tag syntax and patterns, which provides comprehensive guidance and improves maintainability for complex object-oriented structures.

Related Skills

Explore More Software Engineering Skills→
johan-Rmjohan-Rm

generate-doc-ts-js-vue

Generate standardized JSDoc and contextual comments for TypeScript, JavaScript, and Vue SFC files.

Community
Intermediate
theodrosyimertheodrosyimer

api-docs

Generate a browsable API documentation website from an OpenAPI specification.

Community
Advanced
nguyenphpnguyenphp
41

lint-and-validate

Run linters, type checkers, and security audits across Node.js and Python projects.

Community
Intermediate
tomique34tomique34
8

api-docs-generator

Generate Markdown API documentation from OpenAPI specs, Python docstrings, and JSDoc/TSDoc comments.

Community
Advanced