YUIDoc/javascript-如何记录模块属性

YUIDoc/javascript-如何记录模块属性,javascript,documentation,Javascript,Documentation,我从中复制了一个例子。下面是示例代码,但问题是Store.TAX_RATE在文档中显示为Item的属性,而不是模块Store的属性。有什么建议吗 示例代码: /** * This module contains classes for running a store. * @module Store */ var Store = Store || {}; /** * `TAX_RATE` is stored as a percentage. Value is 13. * @

我从中复制了一个例子。下面是示例代码,但问题是Store.TAX_RATE在文档中显示为Item的属性,而不是模块Store的属性。有什么建议吗

示例代码:

/**
  * This module contains classes for running a store.
  * @module Store
  */
var Store = Store || {};

/**
  * `TAX_RATE` is stored as a percentage. Value is 13.
  * @property TAX_RATE
  * @static
  * @final
  * @type Number
  */
Store.TAX_RATE = 13;


/**
 * @class Item
 * @constructor
 * @param name {String} Item name
 * @param price {Number} Item price
 * @param quantity {Number} Item quantity (the number available to buy)
 */
Store.Item = function (name, price, quantity) {
  /**
    * @property name
    * @type String
    */
  this.name = name;
  /**
    * @property price
    * @type String
    */
  this.price = price * 100;
  /**
    * @property quantity
    * @type Number
    */
  this.quantity = quantity;
  /**
    * @property id
    * @type Number
  */
  this.id = Store.Item._id++;
  Store.Item.list[this.id] = this;
 };

这是因为根据YUIDoc术语,模块只是相关类的集合,所以它只能包含类

您可以改为将Store和Store.Item作为类进行记录:

/**
 * This module contains classes for running a store.
 * @class Store
 */
var Store = Store || {};

/**
 * `TAX_RATE` is stored as a percentage. Value is 13.
 * @property TAX_RATE
 * @type Number
 */
Store.TAX_RATE = 13;

/**
 * @class Store.Item
 */
Store.Item = function (name, price, quantity) {
};