javascript - 记录以对象为参数的 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 文档的带属性的参数部分中找到。