このモジュールを説明する最良の方法を教えてください:
/**
* Common util methods
* @module Utils
*/
var Utils = (/** @lends module:Utils */
function () {
/**
* Some default value
* @constant
* @public
* @static
* @type {string}
*/
var staticConstantField = "Some value";
//export to public access
var exports = {
staticConstantField: staticConstantField,
getUrlArgs: getUrlArgs,
isJSON: isJSON
};
return exports;
/**
* Return url arguments as associate array
* @public
* @static
* @returns {Array} - url args
*/
function getUrlArgs() {
return [];
}
/**
* Validate json
* @public
* @static
* @param {string} json - json as string to validate
* @returns {boolean} - is json valid
*/
function isJSON(json) {
return true;
}
/**
* Some private method
* @private
* @static
* @param {string} json - json to parse
* @returns {object} - parsed object
*/
function parseJson(json) {
return {};
}
})();
この例では、 @public および @static アノテーションは無視され、すべての @public メソッドは「inner」としてマークされ、@private メソッドは「private、inner」としてマークされ、return ステートメントは無視されます。生成されたドキュメントでは、API (コード内の「エクスポート」オブジェクト) として使用できるメソッドと、返されるかどうかがわかりません。
var exports = {
anotherFieldName: staticConstantField,
anotherGgetUrlArgsName: getUrlArgs,
anotherIsJSONName: isJSON
};
この API はドキュメントに表示されません。
生成されたドキュメント: