2

* JSDoc JS-Toolkit で次の関数を文書化する方法 *

このメイン関数のtry and helpメソッドを文書化したいのですが、その方法がわかりませんでした。

/** Sample doc
* @class
* @constructor
* @name Sample
*/
var main=function(){
  this.value="";

  /** help function
  * @param {String} Name
  */
  this.help=function(name){
     console.log('help me'+name);
  }

  /** help function
  * @param {String} Name
  */
  this.try=function(name){
     console.log('try me'+name);
  }

}
4

1 に答える 1

1

私はこれに数時間苦労しました。私は試した：

  • @member
  • @augments
  • @method
  • @this

私が見つけた例とチュートリアルから、メンバー関数と変数は、それらの上にコメントを付けるだけで出力に表示されるはず/** description/*ですが、そうではないことがわかりました。あなたと同じように、私は標準の JavaScript コンストラクターを使用しています。配置されthisているため、自動的に推論できるはず@constructorです。見えないシワがあるのか​​もしれません。

最終的に、自分に合う 2 つのタグ@nameと@memberof. どちらも、プロパティがメンバーであるオブジェクトを指定できます。この方法での使用@nameは文書化されていません (少なくとも、私はどこにも見ませんでした) が、非常に簡単です。も使用する必要があります@function。

@nameタグを使用した例を次に示します。

/** help function
* @name Sample.try
* @function
* @param {String} Name
*/
this.try=function(name){
    console.log('try me'+name);
};

ここに画像の説明を入力

@memberofタグの例を次に示します。

/** help function
* @memberof Sample
* @function
* @param {String} Name
*/
this.try=function(name){
    console.log('try me'+name);
};

ここに画像の説明を入力

ご覧のとおり、出力はほぼ同じです。私が見る唯一の違いは、メソッド名に@memberof含まれていることです。this.そのため、私は を使用することにしました@name。

残りの問題は、関数が ではなくインスタンスごとであること<static>です。

お役に立てれば！

于 2013-06-19T14:21:55.633 に答える