5

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()」のみが報告され、説明として「Adescriptionhere」が含まれています...ClassNameのメソッドのドキュメントも生成するにはどうすればよいですか?

4

1 に答える 1

7

解決しました!:)

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

})();

@lendsを@nameに置き換えました!

更新:完全なドキュメントを入手するための正しいアプローチは次のとおりです。

/**
 * A description here
 * @class
 */
com.mydomain.ClassName = (function(){

var ClassName = function(){};

/**
 * method description
 * @memberOf com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};

return new ClassName();

})();
于 2012-09-07T10:25:58.177 に答える