js-docstring

Standardize JavaScript documentation with JSDoc-compliant comment guidelines.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/LounisBou/claude-code --skill js-docstring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: js-docstring
Source: https://github.com/LounisBou/claude-code/tree/main/skills-available/js/js-docstring
Command: npx skills add https://github.com/LounisBou/claude-code --skill js-docstring

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

JSDoc documentation standards for JavaScript following jsdoc.app conventions, help teams produce consistent, machine-readable comments that improve IDE support and API documentation.

Core Features & Use Cases

  • Comprehensive guidelines for writing JSDoc comments, including typical tags such as @param, @returns, @type, and @typedef, with example blocks.
  • Facilitates API documentation generation and improves existing code documentation across JavaScript projects.
  • Supports better autocomplete, type hints, and maintainability across teams.

Quick Start

Add a JSDoc comment block above a new JavaScript function following the examples in this guide.

Frequently Asked Questions about js-docstring

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

FAQPage Schema
How do I standardize JavaScript documentation with JSDoc comments?

To standardize JavaScript documentation with JSDoc, you apply structured guidelines for tags like @param, @returns, @type, and @typedef. This enforces consistent, machine-readable comments that improve IDE support and API generation across your project.

What is the best way to generate API docs from JavaScript code?

Generating API docs from JavaScript code is best achieved by enforcing JSDoc-compliant comments. Standardized tags like @param and @returns provide the machine-readable structure required to automatically generate consistent API documentation.

How do I document JavaScript functions and classes for better type hints?

To document JavaScript functions and classes for better type hints, you add JSDoc comment blocks above them using standard tags. This structured approach ensures consistent type hints and improves overall code maintainability across teams.

Does this JSDoc standardization approach work for existing JavaScript projects?

Yes, this JSDoc standardization approach works for existing JavaScript projects. It provides comprehensive guidelines to improve existing code documentation and supports better type hints and maintainability across your current codebase.

What are the limitations of using JSDoc for JavaScript typing?

JSDoc provides type hints and IDE support but relies on consistent manual comment maintenance. It helps standardize documentation and API generation, but does not offer compile-time type checking like a dedicated type system would.