@inheritdoc

Содержание

• Обзор
• Примеры
• Связанные ссылки

Обзор

Тег @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 из %%%CODE_BLOCK_4%%:

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

Связанные ссылки

@override