@use JSDoc

概觀

@inheritdoc 標籤表示符號應從其父類別繼承其文件。您包含在 JSDoc 註解中的任何其他標籤都將被忽略。

提供此標籤以與 Closure Compiler 相容。預設情況下，如果您未將 JSDoc 註解新增至符號，則符號將從其父項繼承文件。

@inheritdoc 標籤的存在表示存在 @override 標籤。

範例

以下範例顯示類別如何表示它從其父類別繼承文件

繼承自父類別的類別
/**
 * @classdesc Abstract class representing a network connection.
 * @class
 */
function Connection() {}

/**
 * Open the connection.
 */
Connection.prototype.open = function() {
    // ...
};


/**
 * @classdesc Class representing a socket connection.
 * @class
 * @augments Connection
 */
function Socket() {}

/** @inheritdoc */
Socket.prototype.open = function() {
    // ...
};

您可以透過省略 Socket#open 中的 JSDoc 註解來獲得相同的結果

在沒有 `@inheritdoc` 標籤的情況下繼承文件
/**
 * @classdesc Abstract class representing a network connection.
 * @class
 */
function Connection() {}

/**
 * Open the connection.
 */
Connection.prototype.open = function() {
    // ...
};


/**
 * @classdesc Class representing a socket connection.
 * @class
 * @augments Connection
 */
function Socket() {}

Socket.prototype.open = function() {
    // ...
};