1.安装nodejs
32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi
64 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi
2.安装apidoc,
npm install -g apidoc
npm 在nodejs安装成功后就有这个命令
3.cd 到指定要生成文档的java目录。执行 apidoc
就会在该目录下生成一个doc文档
4. 设置文档内容样例, 在生成文档前,可在该目录下添加apidoc.json文件,内容例如:
{
"name": "example",
"version": "0.1.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1"
}
关于如果注释代码,请参考官网,