microsoft/tsdoc

Health v2 · maintenance only

Adoption not part of the score

4961 stars · 158 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

TSDoc is a proposed standard for TypeScript doc comments, with an open-source reference parser (@microsoft/tsdoc) that tools can use to extract documentation consistently. The monorepo also includes an ESLint plugin, a tsdoc.json config loader, and a web playground.

Use cases

• parse TypeScript doc comments into a structured AST
• standardize JSDoc-style comments across tools
• lint doc comment syntax with ESLint
• build a custom API documentation generator
• validate doc comment tags like @param and @remarks

When to choose

• you're building a tool that extracts or validates TypeScript doc comments
• you want tool-agnostic, standardized documentation markup
• you need an ESLint plugin to enforce doc comment correctness

When to avoid

• you just need to generate HTML docs from code (use TypeDoc instead)
• your project is plain JavaScript with no TypeScript tooling
• you need Markdown site generation rather than comment parsing

Facets

library · maturity active

parser documentation linter documentation developer-tools programming-languages parsers cross-platform doc-comments jsdoc tsdoc eslint-plugin specification rushstack nodejs typescript

Member repositories

For agents

markdown · JSON · MCP: product_card(name="microsoft/tsdoc")