如何从父类中记录成员函数

How to document a member function from father class

本文关键字：记录 成员 函数 父类      更新时间：2023-10-05

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

我写了

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

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

默认情况下，

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#
 */
相关文章：