@use JSDoc

同義詞

語法

@augments <namepath>

概述

@augments 或 @extends 標籤表示符號繼承自父符號，並可能會新增到父符號。您可以使用此標籤來記錄基於類別和基於原型繼承。

在 JSDoc 3.3.0 及後續版本中，如果符號繼承自多個父項，且兩個父項具有相同名稱的成員，JSDoc 會使用 JSDoc 註解中所列最後一個父項的說明文件。

範例

在以下範例中，Duck 類別定義為 Animal 的子類別。Duck 實例具有與 Animal 實例相同的屬性，以及 Duck 實例獨有的 speak 方法。

記錄類別/子類別關係
/**
 * @constructor
 */
function Animal() {
    /** Is this animal alive? */
    this.alive = true;
}

/**
 * @constructor
 * @augments Animal
 */
function Duck() {}
Duck.prototype = new Animal();

/** What do ducks say? */
Duck.prototype.speak = function() {
    if (this.alive) {
        alert('Quack!');
    }
};

var d = new Duck();
d.speak(); // Quack!
d.alive = false;
d.speak(); // (nothing)

在以下範例中，Duck 類別繼承自 Flyable 和 Bird 類別，這兩個類別都定義了 takeOff 方法。由於 Duck 的說明文件將 @augments Bird 列在最後，因此 JSDoc 會自動使用 Bird#takeOff 的註解來記錄 Duck#takeOff。

具有重複方法名稱的多重繼承
/**
 * Abstract class for things that can fly.
 * @class
 */
function Flyable() {
    this.canFly = true;
}

/** Take off. */
Flyable.prototype.takeOff = function() {
    // ...
};

/**
 * Abstract class representing a bird.
 * @class
 */
function Bird(canFly) {
    this.canFly = canFly;
}

/** Spread your wings and fly, if possible. */
Bird.prototype.takeOff = function() {
    if (this.canFly) {
        this._spreadWings()
            ._run()
            ._flapWings();
    }
};

/**
 * Class representing a duck.
 * @class
 * @augments Flyable
 * @augments Bird
 */
function Duck() {}

// Described in the docs as "Spread your wings and fly, if possible."
Duck.prototype.takeOff = function() {
    // ...
};