1. npm i @microsoft/tsdoc
    1. export class Statistics {
    2.   /**
    3.    * Returns the average of two numbers.
    4.    *
    5.    * @remarks
    6.    * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
    7.    *
    8.    * @param x - The first input number
    9.    * @param y - The second input number
    10.    * @returns The arithmetic mean of `x` and `y`
    11.    *
    12.    * @beta
    13.    */
    14.   public static getAverage(x: number, y: number): number {
    15.     return (x + y) / 2.0;
    16.   }
    17. }

    通过一些列的 tag 来说明。

    • 第一行文字表示摘要
    • 空行
    • @remarks 表示副标题
    • 空行
    • @param 参数，解释
    • @returns 解释参数
    • 空行
    • beta

    表示阶段，范围

    • alpha 初级
    • beta 公测
    • deprecated 弃用
    • experimental
    • public
    • internal

    装饰器注释 decorator 解释装饰内容
    示例 example 写法

    {@link}

    • remarks 补充备注
    • privateRemarks 代码内注释，外部不可见