对于开发者来说，开发和详细的文档注释同样重要。针对当前项目的程序，需要能快速生成当前程序目录文档，并给出说明，推荐一个npm 包 mddir,一键可以生成当前程序目录文档。首先全局安装 mddir包。然后在当前目录下，运行 mddir 就可生成对应的文档
npm install mddir -g
以test 项目为例，这是生成的目录文档实例
|-- test
|-- .eslintrc.js eslint 规则文件
|-- .gitignore 提交倒代码忽略文件
|-- .prettierignore prettier 格式代码忽略文件
|-- .prettierrc prettier 配置
|-- .prettierrc.cjs prettier 配置
|-- babel.config.js babel配置
|-- jsconfig.json vue框架文件
|-- package-lock.json npm lock 文件
|-- package.json npm 包依赖文件
|-- README.md 说明
|-- vue.config.js vue 框架文件
|-- public
| |-- index.html 入口html
|-- src
|-- App.vue 主vue
|-- lang.js 多语言切换注册
|-- main.js 主js
|-- routes.js 中文版路由
|-- routes_en.js 英文版路由
|-- settings.js 配置文件
|-- api api 请求文件夹
| |-- user.js user API
|-- assets 图片文件夹
| |-- images
| | |-- logo.png
| |-- scss
| |-- font.scss 字体样式
| |-- public.scss 公共样式
| |-- reset.scss 重置默认样式
| |-- variables.scss 公共变量样式
|-- components 组件文件夹
| |-- Hamburger Hamburger组件
| | |-- index.vue
| |-- SvgIcon SvgIcon组件
| |-- index.vue
|-- icons
| |-- index.js
| |-- svgo.yml
| |-- svg svg所有图标
| |-- process.svg 数据后处理Icon
|-- lang 多语言配置
| |-- dic.js 字典中英文
| |-- index.js 页面中英文配置
|-- layout 布局文件夹
| |-- index.vue 首页
| |-- components 组件文件夹
| | |-- AppMain.vue 核心展示入口文件
| | |-- BaseDialog.vue 弹窗组件
| | |-- index.js 组件注册文件
| | |-- MainHead.vue 头部组件
| | |-- Navbar.vue 左侧导航栏
| | |-- PopUp.vue 弹出组件
| | |-- Sidebar 左侧栏文件夹
| | |-- index.vue 入口文件
| | |-- Item.vue MenuItem文件
| | |-- Link.vue 链接到文件
| | |-- Logo.vue 控制Logo显示文件
| | |-- SidebarItem.vue SidebarItem文件
| |-- mixin 混入模块
| |-- ResizeHandler.js 界面自适应
|-- mixins
| |-- initData.js 表格查询
|-- store store文件夹
| |-- getters.js
| |-- index.js
| |-- modules
| |-- app.js app module
| |-- key.js key module
| |-- settings.js setting module
| |-- user.js user module
|-- styles
| |-- element-ui.scss element-ui 全局样式修改
| |-- index.scss 入口文件
| |-- mixin.scss 混入样式
| |-- sidebar.scss sidebar样式
| |-- transition.scss transition样式
| |-- variables.scss scss 变量
|-- utils
| |-- auth.js auth权限认证
| |-- EventBus.js eventbus
| |-- get-page-title.js 获取标题工具类
| |-- index.js 入口文件
| |-- request.js HTTP请求文件
| |-- validate.js 校验文件
|-- views 所有界面文件夹
|-- Login.vue 登录
|-- process 数据后处理文件夹
|-- index.vue 首页
|-- dialog 所有弹窗
|-- createDialog.vue 新建工程弹窗
|-- declarDialog.vue 声明弹窗
|-- downFile.vue 下载文件弹窗
|-- logoOut.vue 登出弹窗
|-- taskConfig.vue 查看工程配置弹窗
|-- updatePassword.vue 修改密码弹窗
|-- viewRequirement.vue 上传文件要求弹窗
