@override

描述: 指明一个标识符覆盖其父类同名的标识符。

字典:

- closure

版本: '>=3.3.0'

概述

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