javascript - JSDoc：如何记录父“类”的“选项”对象文字？

Question

我正在使用$.widget()提供方法的 jQuery 的基“类” option()。由于该方法不在我的代码中，因此我没有地方记录该参数。

我试图将 jsDoc 放在默认选项文字中的字段上，但它们根本没有被拾取。然后我尝试在同一个对象字面量上使用@classand@lends标记，但这可能会让人很困惑，因为对象字面量并不是真正的类。

我尝试过的另一种选择是将类似的东西@param options.field description放在构造函数的 jsDoc 中。但是，这样做的缺点是将文档与代码分开。此外，构造函数实际上没有调用参数options，因为它全部由 jQuery 处理。

您的 Javascript 专家如何处理这个问题？是否应该提出一个新标签？

Answer 1

如果我正确理解您的问题，您有一个带有选项对象的函数，并且您想记录它的所有成员？

如何在 JSDoc 中执行此操作的粗略示例如下：

/**
 * @description
 * Compliment someone on their something.
 *
 * @param {Object} options
 * @param {String} options.name    A person's name
 * @param {String} options.feature A person's property
 */
function flatter (options) {
  options = options || {};
  console.log('%s, loving your %s!', options.name, options.feature);
}