JSDoc 和 JavaScript 单例文档

【问题标题】：JSDoc and JavaScript singleton documentationJSDoc 和 JavaScript 单例文档
【发布时间】：2012-09-09 18:32:26
【问题描述】：

我有一个 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()”，其中“A description here”作为描述...如何也为 ClassName 的方法生成文档？

【问题讨论】：

标签： javascript jsdoc

【解决方案1】：

我解决了！ :)

  /**
 * 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();

})();

【讨论】：