1.如何优雅的“编写”api接口文档1） 编写不方便 。每次新增借口的时候都要复制上一个接口 ， 然后再进行修改 ， 一些相同的部分无法复用 ， 接口多了文档会变的很长 ， 还经常需要调整格式 。2） 发布不方便 。文档更新时 ， 需要发给需要的小伙伴 。即使用Git来进行管理 ， 虽然拉取比较方便 ， 但由于文件格式的问题 ， 也不方便比较两次提交的差异 。
由于有这些问题 ， 决定寻找一种更优雅有效的方式来编写文档 。经过比较 ， 发现了apidoc ， 可以比较好的解决上面提到的问题 。apidoc采用了一种类似写代码注释的方式来写文档 ， 支持编写多种语言的文档 。最后生成的文档以网页的形式发布 ， 方便快捷 ， 便于阅读 。下面就来简单介绍一下怎么使用apidoc来写文档 。
1.安装node
由于apidoc依赖Node.js的包管理工具npm进行安装 ， 所以安装apidoc之前要先安装node.js(npm会在安装node时顺带进行安装) 。具体的安装教程可以参考这里 。
2.安装apidoc
安装完了npm之后 ， 就可以安装apidoc了 。在命令行输入
2.java api接口文档编写Java语言提供了一种强大的注释形式：文档注释 。可以将源代码里的文档注释提取成一份系统的API文档 。我们在开发中定义类、方法时可以先添加文档注释 ， 然后使用javadoc工具来生成自己的API文档 。
文档注释以斜线后紧跟两个星号（/**）开始 ， 以星号后紧跟一个斜线（*/）作为结尾 ， 中间部分全部都是文档注释 ， 会被提取到API文档中 。
自行搜索一下javadoc即可 ， 示例如下：
/**
【写api接口文档怎么写】* 类描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 内部属性：name
*/
private String name;
/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}
/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}
}
3.如何快速编写api文档这里所用到的工具就是javadoc2chm.百度”javadoc2chm“下载 。
我看到有一个1积分下载的 ， 我这里也有 ， 需要的话可以私聊 。2javadoc2chm.exe的大小只有102k左右 ， 谨防上当受骗啊 。
3使用javadoc2chm制作帮助文档的时候 ， 首先下载的文件中有帮助文档的html版 。例如我下载的Struts2就有doc目录 。
4打开javadoc2chm.exe. path to javadoc是用来选择doc的路径的 ， output filename是用来给输出的chm一个名字 ， 以.chm结尾 ， title是打开chm后首页的文字5我这里以制作Hadoop2.7.1的帮助文档实例 。选好目录后 ， 点击Go就开始只做了 ， 制作完成后 ， go按键变黑色可用 ， 只做好的chm文档存放在你选择的html帮助文档的目录里 。
END注意事项注意output filename是用来给输出的chm一个名字 ， 以.chm结尾如果不是 ， 输出后改一下工作愉快！点赞啊 。
文章插图