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

【问题标题】：Documenting JS function which takes an object as an argument记录以对象为参数的 JS 函数
【发布时间】：2026-01-07 11:30:01
【问题描述】：

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

【问题讨论】：

标签： javascript function object documentation arguments

【解决方案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 的 Parameters with Properties 部分中找到。

【讨论】：