育才学习网1. 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;
}
}
2. 如何优雅的“编写”api接口文档
1） 编写不方便。每次新增借口的时候都要复制上一个接口，然后再进行修改，一些相同的部分无法复用，接口多了文档会变的很长，还经常需要调整格式。2） 发布不方便。文档更新时，需要发给需要的小伙伴。即使用Git来进行管理，虽然拉取比较方便，但由于文件格式的问题，也不方便比较两次提交的差异。
由于有这些问题，决定寻找一种更优雅有效的方式来编写文档。经过比较，发现了apidoc，可以比较好的解决上面提到的问题。apidoc采用了一种类似写代码注释的方式来写文档，支持编写多种语言的文档。最后生成的文档以网页的形式发布，方便快捷，便于阅读。下面就来简单介绍一下怎么使用apidoc来写文档。
1.安装node
由于apidoc依赖Node.js的包管理工具npm进行安装，所以安装apidoc之前要先安装node.js(npm会在安装node时顺带进行安装)。具体的安装教程可以参考这里。
2.安装apidoc
安装完了npm之后，就可以安装apidoc了。在命令行输入
3. API是什么意思
API (Application Programming Interface)
所谓API本来是为C和C++程序员写的。API说来说去，就是一种函数，他们包含在一个附加名为DLL的动态连接库文件中。用标准的定义来讲，API就是Windows的32位应用程序编程接口，是一系列很复杂的函数，消息和结构，它使编程人员可以用不同类型的编程语言编制出的运行在Windows95 和Windows NT操作系统上的应用程序。可以说，如果你曾经学过VC，那么API对你来说不是什么问题。但是如果你没有学过VC，或者你对Windows95的结构体系不熟悉，那么可以说，学习API将是一件很辛苦的事情。
如果你打开WINDOWS的SYSTEM文件夹，你可以发现其中有很多附加名为DLL的文件。一个DLL中包含的API函数并不只是一个，数十个，甚至是数百个。我们能都掌握它嘛？回答是否定的∶不可能掌握。但实际上，我们真的没必要都掌握，只要重点掌握Windos系统本身自带的API函数就可以了。但，在其中还应当抛开掉同VB本身自有的函数重复的函数。如，VB 的etAttr命令可以获得文件属性，SetAttr可以设置文件属性。对API来讲也有对应的函数
GetFileAttributes 和SetFileAttributes，性能都差不多。如此地一算，剩下来的也就5、600个。是的，也不少。但，我可以敢跟你说，只要你熟悉地掌握 100个，那么你的编程水平比现在高出至少要两倍。尽管人们说VB和WINDOWS具有密切的关系，但我认为，API更接近
WINDOWS。如果你学会了API，首要的收获便是对WINDOWS体系结构的认识。这个收获是来自不易的。
4. 什么是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