php inheritdoc,@inheritdoc

@inheritdoc

描述: 指明这个标识应继承其父类的文档。

版本: '>=3.3.0'

Overview(概述)

@inheritdoc标签指示该标识应继承其父类的文档。在你的JSDoc注释中的任何其它标签都将被忽略。

这个标签是为Closure Compiler提供了兼容性。默认情况下，如果不给标识符加JSDoc注释，标识符将继承其父级的文档。

@inheritdoc标签的存在意味着@override 标签存在。

Examples(例子)

下面的例子显示了一个类的描述如何从它的父类继承文档。

例如，一个类继承自他的父类：/**

* @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() {

// ...

};