Backbone.js 如何创建JSDoc主干属性/选项

我试图确定使用JSDoc 3将属性和选项参数记录到

主干.Model

的最佳方法

理想情况下，我希望能够做到：

/**
  * @class
  * @attribute {string} foo the foo attribute
  * @attribute {integer} bar the bar attribute
  * @option    {bolean} baz the baz option
  * @option    {string} qux the qux option
  */
var MyModel = Backbone.Model.extend({
    ...
});

然而，JSDoc 3中没有

@选项

标记，

@属性

与主干属性的含义不同。从理论上讲，我认为人们可以以某种方式制作自定义标记，就像我的伪代码中的标记一样，但我找不到任何现有的带有这些标记的插件，而且关于如何创建自定义标记的文档几乎不存在

因此，由于我现在似乎一直在使用内置标记，我的问题是：我的伪代码（使用实际的JSDOC3标记）的下一个最好的方面是什么

---

注意：有几个与此（，）类似的问题，但它们都集中在识别主干对象的“大图”上。我找不到任何专门解决属性/选项问题的方法。

我最终在这个（非主干特定的）堆栈溢出线程中找到了答案：

总之，您可以通过创建初始参数（例如，

@param attributes

），然后创建

@param attributes.foo

或

@param options.bar

标记来记录属性/选项。换句话说，我的伪代码可以用以下语法正确地重新编写：

/**
  * @class
  * @param {Object} attributes
  * @param {string} attributes.foo the foo attribute
  * @param {integer} attributes.bar the bar attribute
  * @param {Object} options
  * @param {boolean} options.baz the baz option
  * @param {string} options.qux the qux option
  */
var MyModel = Backbone.Model.extend({
    ...
});

我仍然认为，如果有某种JSDoc3主干插件允许使用

@attribute

/

@option

标记，那将是更好的选择，因此如果有人将其作为答案发布，我将乐意接受该答案，而不是我自己的答案