最适合生成Vue.js和javascript / typescript文档的工具

时间:2019-05-03 12:15:44

标签: javascript typescript vue.js vuejs2 documentation-generation

我最近在工作中启动了一个新的Vue.js项目,我想以适当的方式来做文档。

我尝试使用一些文档生成工具,但是找不到真正适合我需要的工具。最后一个是https://github.com/vuese/vuese,但是这只允许我为.vue组件生成文档,而不是为所有.js文件(将来可能还会是.ts)生成文档,并且它一次生成所有文件。目录,而不是我的src文件夹。

是否有任何文档生成工具可以让我做我想念的事情,还是应该尝试使用此功能制作自己的文档生成器?

我不知道是否有帮助,但这是我当前的项目文件夹结构:

+-- assets
    +-- any png, svg, typical asset files
+-- components
    +-- component_collection
        +-- SubComponent1.vue
        +-- SubComponent2.vue
        +-- ...
+-- core
    +-- middleware
        +-- auth.js
    +-- pages
        +-- App.js
        +-- NavigationBar.vue
    +-- plugins
        +-- vuegooglemaps.js
    +-- router
        +-- index.js
        +-- user.js
    +-- themes
        +-- colorscheme1.js
        +-- colorscheme2.js
    +-- main.js
+-- services
    +-- ApiService.js
    +-- UserService.js
    +-- other services
+-- store
    +-- index.js
    +-- modules
        +-- index.js
        +-- ui.js
        +-- user.js
+-- views
    +-- user
        +-- Login.vue
    +-- component1
        +-- create.vue
        +-- read.vue
        +-- update.vue
        +-- delete.vue
    +-- component2
        +-- create.vue
        +-- read.vue
        +-- update.vue
        +-- delete.vue 
    +-- Home.vue

亲切的问候

0 个答案:

没有答案