2

YUIDoc で、パラメーターとして渡されるオブジェクト リテラルにコメントを付けたい。次のコード スニペットを参照してください。

@param {Array} colDefs Array of object literal column definitions for the grid<ul>
    <li>title -  Column header display</li>
    <li>key -  The key of the column from the JSON data array</li>
    <li>type - The data type of the column.  </li></ul>

プロパティのタイプ (文字列、オブジェクトなど) を指定できるようにするには、リスト項目にどのタグを追加すればよいですか? {String} を追加すると、@param タグで得られる適切な書式設定ではなく、テキストとして表示されます。

おそらくこれは不可能ですか？

4

1 に答える 1

6

最初に構成オブジェクトを指定し、次にすべてのプロパティをobject.propertyパラメーターとして指定することにより、構成オブジェクトを文書化できます。次のようになります。

 /**
 @param {Object}  config          Object literal containing configuration parameters
 @param {Boolean} config.useFoo   Whether to use Foo or not
 @param {String}  [config.option] An optional string parameter
 */
于 2013-02-05T18:38:55.523 に答える