[英]Documenting member functions with JSDoc
我有这样的事情:
/**
Diese Klasse bla bla...
@constructor
**/
my.namespace.ClassA = function(type)
{
/**
This function does something
**/
this.doSomething = function(param){
}
}
该类将在生成的文档中列出。 该功能不会。 有没有办法告诉JSDoc(3)这是ClassA
类的成员函数?
试试这个!
/**
* Diese Klasse bla bla...
* @constructor
*/
my.namespace.ClassA = function(type)
{
/**
* This function does something
* @function doSomething
* @memberOf my.namespace.ClassA#
*/
this.doSomething = function(param){
};
};
JSDoc在这方面看起来很笨重:/关键是指定memberof和函数的名称。 另见 。
JSDoc需要一些额外的信息来将函数识别为成员函数:
/**
* Diese Klasse bla bla...
* @constructor
*/
my.namespace.ClassA = function(type)
{
/**
* This function does something
* @function
* @memberOf my.namespace.ClassA
*/
this.doSomething = function(param){
}
}
您需要使用全名路径显式描述该函数。 有三种类型的名称路径语法来描述函数:
Person#say // the instance method named "say."
Person.say // the static method named "say."
Person~say // the inner method named "say."
请参阅本页的详细信息。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.