TypeScriptコメントの構文はどこに記載されていますか? 質問する

Question

現在

TypeScript チームとその他の TypeScript 関係チームは、TSDoc 仕様を作成しました。詳しくはこちら

ドキュメントから直接引用した例:

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;
  }
}

過去

TypeScriptはJSDocを使用します。例:

/** This is a description of the foo function. */
function foo() {
}

jsdoc を学ぶには:https://jsdoc.app/

ただし、JSDoc では型注釈拡張機能を使用する必要はありません。

などの他の jsdocブロックタグも引き続き使用できます (また、使用する必要があります)。@returns

単なる例です。内容ではなく種類に注目してください。

JSDoc バージョン (ドキュメント内の通知タイプ):

/**
 * Returns the sum of a and b
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a, b) {
    return a + b;
}

TypeScript バージョン (型の再配置に注意してください):

/**
 * Takes two numbers and returns their sum
 * @param a first input to sum
 * @param b second input to sum
 * @returns sum of a and b
 */
function sum(a: number, b: number): number {
    return a + b;
}

Answer 1

現在