如何在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,Object等)？如果我添加{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
 */