javascript - メソッドが yuidoc で {id: String, label: String} の配列を受け入れることを確認するにはどうすればよいですか?

Question

ドキュメントで見つけられません。

私が好むのは[{id: String, label: String}]、生成されたドキュメントに型を表示することです.実験の結果、私ができる唯一のことは、他の文字なしで単一の英数字のみの文字列を指定することであると思いました(ジェネレーターによって無視されます)。

それを行う方法は本当にありませんか？

Answer 1

その情報 (id と label の 2 つの属性) を指定する @class を作成し、そのクラスを使用するだけです!

Answer 2

2 つの解決策があります。

1) 実際の名前付きクラスを作成し、タグ@classと@paramタグを使用してそれを文書化します。リテラル オブジェクト{id: String, label: String}は基本的にインライン/匿名クラスであるためです。ですから、匿名ではなく、実際に名前を付けてください。次に、パラメーターがそのクラスの配列であることを指定できます。そのようです：

/**
 * @class MyLabel
 * @constructor
 * @param id {String}
 * @param label {String}
 */
function MyLabel(id, label) {
  this.id = id;
  this.label = label;
}

/* ... and then document your method, with the array of those objects, using: */

/**
 * @method myMethod
 * @param labels {MyLabel[]} Array of labels.
 */

これがオプション 1 であり、コードのリファクタリングが必要です。しかし、クラスに名前を付けて定義し、文書化することを恐れないでください。良いことだけが得られます。

2) もう 1 つのオプションは、JSDocs からページを取得し、疑似パラメーター構文を使用することです。

/**
 * @method myMethod
 * @param labels {Object[]} An array of label objects
 * @param labels[].id {String} Id
 * @param labels[].label {String} Label  
 */

これは YUIdoc でも正しくレンダリングされると確信しています。