【JavaScript/TypeScript】 JSDoc/TypeDoc チートシート

/**
 * 文字列 foo を出力する
 */
export function foo() {
    console.log('foo');
}

/**
 * @returns {string} 文字列 foo
 * @description 文字列 foo を返す
 */
export function foo() {
    return 'foo';
}

/**
 * 文字列 foo を返す
 * @returns {string} 文字列 foo
 */
export function foo() {
    return 'foo';
}

/**
 * @param {string} userName ユーザーの名前
 */
export function sayHello(userName) {
    alert('Hello ' + userName);
}

/**
 * 座標
 * @property {number} x X軸の値
 * @property {number} y Y軸の値
 * @property {number} distance 引数の Point からの距離を計算する
 */
export class Point {
    readonly x: number;
    readonly y: number;

    constructor(x: number, y: number) {
        this.x = x;
        this.y = y;
    }

    distance(p: Point): number {
        return Math.hypot(this.x - p.x, this.y - p.y);
    }
}

/**
 * 季節
 * @enum {string}
 */
export const SEASONS = {
  /** 春 */
  SPRING: '春',
  /** 夏 */
  SUMMER: '夏',
  /** 秋 */
  AUTUMN: '秋',
  /** 冬 */
  WINTER: '冬'
};

/**
 * 引数が数値であれば引数を返す
 * @throws {TypeError} 引数が数値でない場合
 */
export function foo(x: any): number {
    if (typeof x !== 'number') {
        throw new TypeError('x is not a number');
    }
    return x;
}

/**
 * 文字列 foo を返す
 * @examle
 * // returns 'foo'
 * console.log(foo());
 */
export function foo() {
    return 'foo';
}

/**
 * 引数が数値であれば引数を返す
 * @throws {TypeError} 引数が数値でない場合
 * @example <caption>成功する例</caption>
 * foo(1); // 1
 * @example <caption>失敗する例</caption>
 * foo('a'); // TypeError: x is not a number
 */
export function foo(x: any): number {
    if (typeof x !== 'number') {
        throw new TypeError('x is not a number');
    }
    return x;
}

/**
 * ほげほげふがふが
 * @remarks ここに補足情報を書きます
 */
export function foo() {}