JAVA APIDOC 文档使用教程

1. Windows下载： https://nodejs.org/dist/v8.11.3/node-v8.11.3-x64.msi

2. Mac下载： https://nodejs.org/dist/v8.11.3/node-v8.11.3.pkg

使用node.js 进入黑窗口

输入 npm install -g apidoc 命令

安装完成

在项目下创建apidoc.json文件

打开文件编辑模板

 

使用管理员黑窗口cmd 进入本机项目路径 F://xxx/xxx/xxx 项目

输入命令apidoc 

完成会把doc文件夹创建在该项目下 

 注意@apiGroup 分组的名 每个都不能重复，重复则只显示第一个分组，其他方法都看不见

如果是中文导致api文档内看不到分组名，可以执行下面

进入

C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\

下的api_group.js文件

注释掉//group = group.replace(/[^\w]/g, '_');

保存退出，删除项目内的doc文件夹 重新黑窗口输入apidoc重新生成api文档就可以显示了