microsoft/tsdoc
Some data may be outdated — see provenance labels.
A doc comment standard for TypeScript observed · 2026-10-02
Health v2 · maintenance only
66/100
- Activity 97
- Release rhythm 8
- Longevity 100
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-10-21. Adoption (stars, forks) is never an input.
- gap_med: n/a
- age_days: 3156
- days_rel: n/a
- days_push: 19
- n_releases_24m: 0
Adoption not part of the score
4968 stars · 162 forks observed · 2026-10-02
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
3 sources
- readme: https://github.com/microsoft/tsdoc · fetched 2026-10-02 · f086c667726f
- homepage: https://tsdoc.org/ · fetched 2026-08-29 · 28de9dd89d0b
- site_page: https://tsdoc.org/pages/tags/packagedocumentation · fetched 2026-08-29 · bfbf874624c3
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| microsoft/tsdoc | main | 66 |
For agents
Data as of 2026-10-19T08:05:51.212177+00:00 · Report a problem