@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() {
    // ...
};

JSDoc コメントを Socket#open から省略しても同じ結果が得られます。

`@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() {
    // ...
};