# microsoft/tsdoc

A doc comment standard for TypeScript

Repository: https://github.com/microsoft/tsdoc
Canonical: https://ross.abutalabs.com/products/tsdoc
Homepage: https://tsdoc.org/
Language: TypeScript
License: MIT
License Family: permissive
Topics: typescript, documentation, comments, syntax, jsdoc, parser, specification, doc-comments, markdown, rushstack
Last push: 2026-08-24T22:40:36+00:00

## Health v2 (maintenance only)
Score: 67/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 8, longevity 100
- inputs: {"age_days": 3108, "days_push": 9, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4961, forks 158 (observed 2026-08-28T04:09:03.890408+00:00)

## What it is
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
- artifact type: library
- maturity: active
- function: parser, documentation, linter
- domain: documentation, developer-tools, programming-languages, parsers
- platform: cross-platform
- tags: doc-comments, jsdoc, tsdoc, eslint-plugin, specification, rushstack, nodejs, typescript

## Member repositories
- microsoft/tsdoc (main) score 67

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:03.890408+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:17:48.043576+00:00, confidence not recorded.
  - readme: https://github.com/microsoft/tsdoc (fetched 2026-08-28T04:09:03.890408+00:00, sha f086c667726f)
  - homepage: https://tsdoc.org/ (fetched 2026-08-29T08:59:30.387684+00:00, sha 28de9dd89d0b)
  - site_page: https://tsdoc.org/pages/tags/packagedocumentation (fetched 2026-08-29T08:59:30.397102+00:00, sha bfbf874624c3)
- Data as of 2026-08-30T08:39:29.467469+00:00.