JSDoc和JavaScript单例文档
我将JavaScript单例定义为:JSDoc和JavaScript单例文档,javascript,jsdoc,Javascript,Jsdoc,我将JavaScript单例定义为: /** * A description here * @class */ com.mydomain.ClassName = (function(){ /** * @constructor * @lends com.mydomain.ClassName */ var ClassName = function(){}; /** * method description * @public * @lends com.mydomain.Cla
/**
* 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的方法生成文档呢?我已经解决了!:)
我刚刚用@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();
})();
/**
* A description here
* @class
*/
com.mydomain.ClassName = (function(){
var ClassName = function(){};
/**
* method description
* @memberOf com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};
return new ClassName();
})();