3

を拡張するモジュールを宣言する場合dojo/Stateful、getter と setter のパターンは定義され_xxxGetter、and_xxxSetterとして明示され.get('xxx')ます.set('xxx')。

それで、私の質問は、これを JSDoc でどのように文書化するのが最善ですか? @function代替メソッド名の提供をサポートしていないようですが、とにかく、これはメソッド名ではなくパラメーター値のバリエーションですか?

では、JSDoc はこのモデルを固有にサポートしていますか? それとも、このようなものについて明示的なドキュメントを書く必要があるだけですか?

4

1 に答える 1

3

では、ドキュメントを単独で生成する場合はどうでしょうか。これを試してください：https ：//github.com/jsdoc3/jsdoc

複数のドキュメントブロックまたは変数/関数をスタックできるようになりました。これに頭を下げないでください-しかし、構文はそのようなものだと思います：

{
 ...
 /**
  * Get varname property
  * @returns {mixed}
  *//**
  * Set varname property
  * @param {mixed} val
  * @returns {this}
  */
  varname: null
 ...
}
于 2012-08-21T07:51:38.007 に答える