JSDoc:显示模块的嵌套树,而不是项目中所有模块的列表

时间:2018-10-29 08:53:27

标签: javascript documentation jsdoc jsdoc3

我正在尝试为中型项目生成jsdoc。项目结构如下:

-src
--commands
--components
---dirA
----ComponentA.js
---dirB
----ComponentB.js
--config
--constant
--page
---pageDirA
----PageA.js
---pageDirB
----PageB.js
--util

如果为此生成jsdoc,我只会在侧栏中获得所有模块的列表。如果我要包括所有的类/模块,它将创建一个庞大的列表,不容易浏览。

类/模块的示例:

import Header from '../component/Header';

/**
 * The abstract pager modal containing components and configuration that is used on all pages.
 *
 * @author Cornel
 * @module
 */
class AbstractPage {

  constructor() {
    this._url = '';

    this._header = new Header();
  }

  get url() {
    return this._url;
  }

  get header() {
    return this._header;
  }
}

export default AbstractPage;

有什么办法可以使我具有使用jsDoc生成的文档的树形结构?

0 个答案:

没有答案