1 | # @microsoft/tsdoc
|
2 |
|
3 | 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.
|
4 |
|
5 | ### What is TSDoc?
|
6 |
|
7 | **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:
|
8 |
|
9 | ```typescript
|
10 | export class Statistics {
|
11 | /**
|
12 | * Returns the average of two numbers.
|
13 | *
|
14 | * @remarks
|
15 | * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
|
16 | *
|
17 | * @param x - The first input number
|
18 | * @param y - The second input number
|
19 | * @returns The arithmetic mean of `x` and `y`
|
20 | *
|
21 | * @beta
|
22 | */
|
23 | public static getAverage(x: number, y: number): number {
|
24 | return (x + y) / 2.0;
|
25 | }
|
26 | }
|
27 | ```
|
28 |
|
29 | ## Give it a try!
|
30 |
|
31 | Check out the [TSDoc Playground](https://microsoft.github.io/tsdoc/) for a cool live demo of our parser!
|
32 |
|
33 | ## Get involved
|
34 |
|
35 | The **TSDoc** project is actively evolving. Please visit our GitHub project for the latest documentation, instructions for building/debugging the projects, and other resources:
|
36 |
|
37 | https://github.com/Microsoft/tsdoc
|