Write concise JSDoc comments for TypeScript code using @default, @example, and @note.
npx skills add https://github.com/kubb-labs/fabric --skill jsdoc
Please help me install this Agent Skill. Skill: jsdoc Source: https://github.com/kubb-labs/fabric/tree/main/.skills/jsdoc Command: npx skills add https://github.com/kubb-labs/fabric --skill jsdoc
Developers often struggle to document TypeScript code consistently, and inconsistent documentation hurts maintainability and onboarding. JSDoc provides inline, human-readable explanations that stay close to the code.
Annotate a sample TypeScript interface with JSDoc comments following the guidelines.
High-intent search queries and answers about installing and using this skill.
To write JSDoc for TypeScript without redundancy, describe what a property does rather than its type. This minimal tagging approach uses @default, @example, and @note to convey defaults, usage, and caveats.
The best way to document complex TypeScript configuration objects is using concise JSDoc comments. Apply tags like @default, @example, and @note to clarify intent, defaults, and caveats close to the code.
You need inline documentation for TypeScript library APIs when explaining usage intent for complex data structures or configuration objects. JSDoc provides human-readable explanations that stay close to the code to improve maintainability.
JSDoc works well with TypeScript types by avoiding redundant type repetition. It enforces consistent conventions for properties, focusing on describing what the property or option does rather than restating existing type definitions.
The limitation of a minimal JSDoc tagging approach is that it relies on only @default, @example, and @note tags. It intentionally omits extensive tagging to avoid redundancy with TypeScript types, focusing strictly on inline intent clarification.
vecearGenerate Markdown or HTML API documentation from TypeScript sources using JSDoc comments.
theodrosyimerGenerate a browsable API documentation website from an OpenAPI specification.
EsposterEnforce oxlint and ESLint conventions for TypeScript projects.
ricableWrite structured documentation for codebases, APIs, and technical workflows.
