我从 here 复制了一个示例。下面是示例代码,但问题是 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) {
};
关于javascript - YUIDoc/javascript - 如何记录模块属性,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15063561/