Question

我正在一个有多个文件的项目中，每个文件包含一个类定义或一个对象。一切都是全局对象的成员。结构是这样的：

main.js
lib/
 - module1.js
 - module2.js
  ...
 - moduleN.js

main.js是这样的：

/**
 * Main object
 */
var APP = {};

例如，module1.js是类的定义：

/**
 * Class1
 */
APP.Class1 = class {
  constructor(args) {
    ...
  }

  /**
   * This method does something
   * @param args
   * @return something
   */
  someMethod(args) {
     ...
     return something
  }
}

但是有时候我只有一个对象（例如module2.js）

/**
 * Object2
 */
APP.Object2 = (function() {
    var somePrivateVar = 1;

    return {
        /**
         * Some method
         * @param arg
         * @returns something
         */
        someMethod: function(arg) {
            ...
            return something;
        }
    }
})();

我想对此进行记录，我刚刚找到了看起来很标准且具有许多功能的jsdoc工具。

我的问题是，记录这样一个项目的最佳实践（如果有）是什么？ jsdoc仅检测到该类，而未添加其他任何内容。同样，在jsdoc生成的页面中，APP位于Global部分的下方，但该类在Classes上被分隔。它不应该在APP下吗？

记录具有多种类型对象的项目的正确方法

0 个答案: