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