2013-11-25 3 views
0

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

Я написал

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

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

ответ

0

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# 
*/ 
+0

WOW ~ Он работает после добавления «#» в тег @memeberof. Очень благодарю вас! – Tom76kimo

Смежные вопросы