@use JSDoc

概要

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