如何记录父类的成员函数

【问题标题】：How to document a member function from father class如何记录父类的成员函数
【发布时间】：2013-11-25 20:12:47
【问题描述】：

如何记录父类的成员函数。有一个具有成员函数 Afunc() 的类 A，我将记录类 B 扩展 A。我没有覆盖 B 中的 Afunc()，但我需要在我的文档中出现函数 Afunc()，我该怎么做？

我写了

/**
 * description
 * @function Afunc
 * @memberOf A
 */

它在文档中出现 Afunc 时有效，但在函数名称的开头有一个 <static> 标记。我该如何解决？谢谢大家。

【问题讨论】：

标签： javascript jsdoc

【解决方案1】：

jsdoc 3.2.2 默认做你想做的事。在此示例中，方法 B.foo 将自动记录，因为 B 扩展了 A 并且不会覆盖 foo：

/**
 * @class
 */
function A() {
}

/**
 * Foo the flerbl.
 * @param {Object} flerbl The flerbl.
 */
A.prototype.foo = function (flerbl) {
};

/**
 * @class
 * @extends A
 */
function B() {
}

B.prototype = new A();

否则，您必须在@memberof 标记中使用# 将对象标记为属于该类的实例：

/**
 * description
 * @function Afunc
 * @memberof A#
 */

【讨论】：

WOW~ 在我的@memeberof 标签中添加“#”后它就可以工作了。真的非常感谢！