育才学习网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即可，示例如下：
/**
* 类描述
*
* @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结尾如果不是，输出后改一下工作愉快！点赞啊。
4.什么是接口文档,如何写接口,有什么规范
首先要有一个文档的标题，XXX接口文档，符合当前文档的说明，文档的生产日期，以及公司名称等。现在开始写一个dubbo接口文档，定义标题，以及日期，这里公司省略。使用confluence在线编辑，Confluence为团队提供一个协作环境。团队成员协同地编写文档和管理项目。从此打破不同团队、不同部门以及个人之间信息孤岛的僵局，Confluence实现了资源的共享。
接下来要有当前文档的版本修订信息，即为历史修订信息，应当包含基础的信息有：版本号、修订日期、修订人、修订说明等。
开始编写文档的目录结构，注意大标题和小标题的使用，需要合理的运用说明。首先当然是文档的说明信息，再来是一些准备信息和流程信息，然后开始接口说明，最后可以有举例、常见问题、注意事项、响应码的说明信息等等。
下面开始按照文档的目录结构逐一进行详细的介绍说明，比如文档说明的介绍，用高效简洁的语言明确的说明文档信息，注意文档中大标题应当字体大小样式一致，小标题也应当字体大小注意保持一致。
简单的说明技术资料获取及准备，确认调用系统信息比较重要，需要确认编码格式，防止乱码，确认当前的文档版本是否是要使用的版本，否则白做无用功，项目的搭建环境简单说明即可。
开始说明接口的调用流程，如何调用接口，需要做的一些准备，说明引入相应的依赖以及配置需要配置的文件。
现在可以开始接口的说明，接口的说明信息应当包含接口的名称，接口的地址，接口的协议，然后针对当前接口下的方法说明。
方法的说明应当包含方法的描述，即其作用，方法的请求参数说明，以及响应的参数说明，参数说明应当包含参数的类型，参数名称，参数的含义，并且备注参数是否必须传递。
9
接口说明完之后，就是文档的末尾，有注意事项添加一些注意事项，或者附录说明，添加标注。
5.什么是API文档
【2006-02-08 13:54】【】【SUN】 Sun 公司提供的Java API Docs是学习和使用Java语言中最经常使用的参考资料之一。但是长期以来此文档只有英文版，对于中国地区的Java开发者来说相当的不便。目前Sun 公司正在组织多方力量将此文档翻译成中文，并于近日在Sun 中国技术社区（.cn/）正式发布java.lang和java.util类库API 文档的中文版，其他类库API文档的中文版也将于今后一段时间内陆续向中国地区的开发人员提供。在J2SE API文档（5.0版本）的汉化工作完成之后，Sun 中国技术社区还将开通Java API 文档中文版的打包下载服务。
Java API 文档中文版发布计划
发布时间 相关类库 阅读/下载
2005/10/31 java.lang
java.util 在线阅读
2005/12/31 java.awt
java.io
java.text 在线阅读
2006/02/28 javax.swing 在线阅读
2006/03/31 java.applet
java.beans
java.maths
java.net
java.nio
java.rmi
java.security
java.sql
javax.accessibility
javax.activity
javax.crypto
2006/04/30 javax.imageio
javax.management
javax.net
javax.naming
javax.print
javax.rmi
javax.security
javax.sound
2006/05/31 javax.sql
javax.transaction
javax.xml
org.ietf
org.xml
org.w3c
org.omg
原文地址：.cn/chinese_java
转载请注明出处育才学习网 » api开发文档怎么写