Question

我正在使用jQuery的$.widget() base“class”，它提供了option()方法。由于该方法不在我的代码中，因此我无法记录参数。

我试图将jsDoc放在默认选项文字的字段中，但它们根本就没有被选中。然后我尝试在同一个对象文字上使用@class和@lends标签，但这可能会让人感到困惑，因为对象文字实际上并不是一个类。

我尝试的另一个选择是在构造函数的jsDoc中添加@param options.field description之类的东西。但是，这样做的缺点是将文档与代码分开。此外，构造函数实际上没有名为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);
}

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

1 个答案: