JSDoc和JavaScript单例文档

Question

我有一个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方法的文档？

- daveoncode

Answer 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();

})();

- daveoncode