Как документировать функцию-член из класса отца

Question

Как я документирую функцию члена от класса отца. Есть класс A с функцией-членом Afunc(), и я собираюсь документировать, что класс B расширяет A. Я не перезаписываю Afunc () в B, но мне нужно, чтобы функция Afunc () появилась в моем документе, как мне это сделать? Это?

я написал

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

Это работает, что появляется Afunc в документе, но есть <static> тег в начале имени функции. Как мне это решить? Спасибо всем.

Answer 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#
 */