typescript-jsdoc-standards

Community

Enforce TypeScript/React JSDoc standards.

AuthorDavidKk
Version1.0.0
Installs0

System Documentation

What problem does it solve?

TypeScript and React code often suffers from inconsistent comments and missing JSDoc documentation, making functions and classes hard to understand and maintain.

Core Features & Use Cases

  • All exported functions, classes, and interfaces include complete JSDoc describing behavior, parameters, and return values.
  • Comments are strictly in English and follow the standard /** ... */ JSDoc format, improving readability and maintainability.
  • Use during code reviews or as part of a CI lint step to enforce documentation quality and reduce onboarding time for new developers.

Quick Start

Install and run the TypeScript/JSDoc checker on your project to automatically validate comment coverage and formatting.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: typescript-jsdoc-standards
Download link: https://github.com/DavidKk/vercel-web-scripts/archive/main.zip#typescript-jsdoc-standards

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.