@use JSDoc

ES 2015 類別

JSDoc 3 可以輕鬆地記錄遵循 ECMAScript 2015 規範 的類別。您不需要對 ES 2015 類別使用標籤，例如 @class 和 @constructor，JSDoc 會透過解析您的程式碼自動辨識類別及其建構函式。ES 2015 類別在 JSDoc 3.4.0 及更新版本中獲得支援。

記錄一個簡單的類別

以下範例顯示如何記錄一個具有建構函式、兩個實例方法和一個靜態方法的簡單類別

簡單的 ES 2015 類別
/** Class representing a point. */
class Point {
    /**
     * Create a point.
     * @param {number} x - The x value.
     * @param {number} y - The y value.
     */
    constructor(x, y) {
        // ...
    }

    /**
     * Get the x value.
     * @return {number} The x value.
     */
    getX() {
        // ...
    }

    /**
     * Get the y value.
     * @return {number} The y value.
     */
    getY() {
        // ...
    }

    /**
     * Convert a string containing two comma-separated numbers into a point.
     * @param {string} str - The string containing two comma-separated numbers.
     * @return {Point} A Point object.
     */
    static fromString(str) {
        // ...
    }
}

您也可以記錄在類別表達式中定義的類別，它會將類別指定給一個變數或常數

ES 2015 類別表達式
/** Class representing a point. */
const Point = class {
    // and so on
}

擴充類別

當您使用 extends 關鍵字來擴充現有類別時，您也需要告訴 JSDoc 您要擴充哪個類別。您可以使用 @augments (或 @extends) 標籤 來執行此操作。

例如，要擴充上面顯示的 Point 類別

擴充 ES 2015 類別
/**
 * Class representing a dot.
 * @extends Point
 */
class Dot extends Point {
    /**
     * Create a dot.
     * @param {number} x - The x value.
     * @param {number} y - The y value.
     * @param {number} width - The width of the dot, in pixels.
     */
    constructor(x, y, width) {
        // ...
    }

    /**
     * Get the dot's width.
     * @return {number} The dot's width, in pixels.
     */
    getWidth() {
        // ...
    }
}