JSDoc和JavaScript单例文档

JSDoc and JavaScript singleton documentation

本文关键字：文档 单例 JavaScript JSDoc      更新时间：2023-09-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的方法生成文档？

我解决了！：）

  /**
 * 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！

UPDATE：获得完整文档的正确方法如下：

/**
 * A description here
 * @class
 */
com.mydomain.ClassName = (function(){
var ClassName = function(){};
/**
 * method description
 * @memberOf com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};
return new ClassName();
})();
相关文章：