ESDoc将我的所有模块方法放在一个标题下,而不是放在每个文件下,如何更改此行为?

时间:2016-05-02 16:53:36

标签: javascript documentation

在我的项目中,我有一个包含一些东西的帮助文件夹......

src/
src/helpers
src/helpers/astring.js
src/helpers/amath.js
src/helpers/adate.js

所有这些都是具有私有和导出方法的模块。使用esdoc生成文档时,我在" helpers"的标题下有一百个左右的方法。一切都搞砸了。我不知道什么是字符串方法,数学方法或日期方法。

有关如何使其更易于管理的任何想法?

1 个答案:

答案 0 :(得分:1)

在EsDoc中,这就是它的工作方式。然而,typhonrt刚刚发布(7小时前)esdoc插件,它将导航区域转换为可折叠列表,代表目录和文件结构。

https://www.npmjs.com/package/esdoc-plugin-enhanced-navigation

这解决了这个问题。