如何在YUIDoc中注释对象文字

Question

在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标记得到的良好格式。

Answer 1

通过首先指定配置对象，然后将所有属性指定为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
 */