记录以对象作为参数的JS函数

Question

在JavaScript或PHP等动态语言中，通常只向函数传递一个参数。该参数是一个封装所有选项的对象。使用ScriptDoc（或类似文件）记录这些选项的最佳方法是什么？

Answer 1

使用JSDoc可以按如下方式完成：

/**
 * @param {Object} o       Object containing function params.
 * @param {String} o.bar   Example String param.
 * @param {Number} o.baz   Example Number param.
 */
function foo(o) {
}

可以在JSDoc TagParam documentation的带属性的参数部分找到更多信息。