@override

Оглавление

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

Обзор

Тег @override указывает, что символ переопределяет символ с таким же именем в родительском классе.

Этот тег предоставляется для совместимости с Closure Compiler. По умолчанию JSDoc автоматически определяет символы, которые переопределяют родительский.

Если ваш комментарий JSDoc включает тег @inheritdoc, вам не нужно включать тег @override. Наличие тега @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() {}

/**
 * Open the socket.
 * @override
 */
Socket.prototype.open = function() {
    // ...
};

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

@inheritdoc