# @microsoft/tsdoc

> A parser for the TypeScript doc comment syntax

Latest version **0.16.0** (published 2025-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @microsoft/tsdoc
pnpm add @microsoft/tsdoc
yarn add @microsoft/tsdoc
bun add @microsoft/tsdoc
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.16.0 |
| Published | 2025-11-11 |
| First published | 2018-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4967 |
| Maintainers | microsoft1es, odspnpm |
| Keywords | TypeScript, documentation, doc, comments, JSDoc, parser, standard |

## Links

- npm: https://www.npmjs.com/package/@microsoft/tsdoc
- Repository: https://github.com/microsoft/tsdoc
- Homepage: https://tsdoc.org/
- Issues: https://github.com/microsoft/tsdoc/issues
- npm.io page: https://npm.io/package/@microsoft/tsdoc

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.16.0 (latest) — 2025-11-11
- 0.15.1 — 2024-11-23
- 0.15.0 — 2024-05-28
- 0.14.2 — 2022-09-14
- 0.14.1 — 2022-04-09
- 0.14.0 — 2022-04-07
- 0.13.2 — 2021-04-20
- 0.13.1 — 2021-04-19
- 0.13.0 — 2021-01-22
- 0.12.24 — 2020-12-03
- 0.12.23 — 2020-12-03
- 0.12.22 — 2020-11-30
- 0.12.21 — 2020-09-04
- 0.12.20 — 2020-05-20
- 0.12.19 — 2020-03-27
- … 36 more at https://npm.io/package/@microsoft/tsdoc/versions

## README

# @microsoft/tsdoc

<div>
  <br />
  <a href="https://tsdoc.org/">
    <img width="200" src="https://tsdoc.org/images/site/tsdoc.svg">
  </a>
  <p />
</div>

This library is the reference implementation of a parser for the TSDoc syntax.  Using this library is an easy way to ensure that your tool is 100% compatible with the standard.


##  What is TSDoc?

**TSDoc** is a proposal to standardize the doc comments used in [TypeScript](http://www.typescriptlang.org/) source files.  It allows different tools to extract content from comments without getting confused by each other's syntax.   The **TSDoc** notation looks pretty familiar:

```typescript
export class Statistics {
  /**
   * Returns the average of two numbers.
   *
   * @remarks
   * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
   *
   * @param x - The first input number
   * @param y - The second input number
   * @returns The arithmetic mean of `x` and `y`
   *
   * @beta
   */
  public static getAverage(x: number, y: number): number {
    return (x + y) / 2.0;
  }
}
```

## Give it a try!

Check out the [TSDoc Playground](https://tsdoc.org/play) for a cool live demo of our parser!


## API Usage

The [api-demo](https://github.com/microsoft/tsdoc/tree/main/api-demo) folder on GitHub illustrates how
to invoke the TSDoc parser.

A separate NPM package [`@microsoft/tsdoc-config`](https://www.npmjs.com/package/@microsoft/tsdoc-config)
is used for loading the **tsdoc.json** file.


## Get involved

The **TSDoc** project is actively evolving.  Please visit the website for the latest documentation, instructions for building/debugging the projects, and other resources:

https://tsdoc.org/

---
_Source: https://npm.io/package/@microsoft/tsdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._