ApiDoc学习使用

一.ApiDoc简介

apidoc可以根据代码注释生成web api文档，支持大部分主流语言java javascript php coffeescript erlang perl python ruby go...，相对而言，web接口的注释维护起来更加方便，不需要额外再维护一份文档。

apidoc从注释生成静态html网页文档，不仅支持项目版本号，还支持api版本号。

二.ApiDoc安装使用

1.安装nodejs。下载地址：http://nodejs.cn/download/

2.安装npm。下载地址：https://github.com/npm/npm/tags

将npm源代码解压到D:\npmjs目录中。
在命令提示符窗口中执行下面的操作，完成npm的安装：

D:\>cd npmjs
D:\npmjs>node cli.js install -gf

3.安装apidocjs。

npm install apidoc -g

4.新建文件夹apiDoc，创建apidoc.json文件，将需要生成文档的java文件或者文件夹放在此目录。

ApiDoc.json

PetResource.java

5.进入apiDoc目录

apidoc 

6.静态页面效果

三.总结

   ApiDoc是完全使用注释实现文档的生成，支持多种语言，生成的文档页面美观，缺点是在需要文档比较详细或者后期需要变化比较多的时候，需要修改很多的注释维护起来不是很方便。

参考资料：

1.主页: http://apidocjs.com/
2.github: https://github.com/apidoc/apidoc