JSDoc：我如何记录下的“选项”对象字面父“下课”？ [重复](JSDoc: How do I

这个问题已经在这里有一个答案：

• 如何形容jsdoc“对象”的论点？ 5个回答

我使用jQuery的$.widget()基地“类”，它提供了一个option()方法。 由于该方法是不是在我的代码，我没有一个地方来记录参数。

我试图把jsDoc在字面的默认选项的领域，但他们根本没有拾起。 然后我试图使用@class和@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);
}

文章来源: JSDoc: How do I document the “options” object literal for a parent “class”? [duplicate]