我有一个 JavaScript 单例定义为:
/**
* A description here
* @class
*/
com.mydomain.ClassName = (function(){
/**
* @constructor
* @lends com.mydomain.ClassName
*/
var ClassName = function(){};
/**
* method description
* @public
* @lends com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};
return new ClassName();
})();
在详细模式 (-v) 下不会打印任何警告,但文档仅报告“com.mydomain.ClassName()”,并以“此处的描述”作为描述...我怎样才能为 ClassName 的方法生成文档?
我解决了! :)
/**
* A description here
* @class
*/
com.mydomain.ClassName = (function(){
/**
* @constructor
* @name com.mydomain.ClassName
*/
var ClassName = function(){};
/**
* method description
* @public
* @name com.mydomain.ClassName.method1
*/
ClassName.prototype.method1 = function(){};
return new ClassName();
})();
我刚刚用@name 替换了@lends!
更新:获得完整文档的正确方法如下:
/**
* A description here
* @class
*/
com.mydomain.ClassName = (function(){
var ClassName = function(){};
/**
* method description
* @memberOf com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};
return new ClassName();
})();
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)