javascript - 如何记录方法的 "object"参数

Question

我正在尝试使用 YUIDoc 为 JavaScript 方法编写一些文档。看起来像:

/** 
    Returns an instance of className

    @method getInstance
    @param {string} className the of the class used to create the instance
    @param {Object} options these are options used to create the instance
**/
function getInstance(className, options) { ..... }

现在，选项对象可以有多个参数，如options.id、options.single等。

如何将此信息添加到此 @param 的文档中？

Answer 1

在编写本文时的当前版本 YUIDOC 0.3.45 中，为了描述方法接收的对象，您应该首先声明对象(选项，在下面的示例中)和然后是带有点符号的属性(例如，options.url)。

/**
 * Describe your method
 *
 * @method yourMethodName
 * @param {object} options - These are the options you may pass
 * @param {string} options.url - the url
 * @param {string} options.otherOption - description of other option
 */