Java API编写

   Javadoc 是 Sun 公司提供的一个技术，它从程序源代码中抽取 类、方法、成员 等注释形 成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的书写注释 的形式对代码作注释，在程序编写完成后，通过 Javadoc 就可以同时形成程序的开发文档 api 了。

   开发者在二次开发中,通过查阅你写的 api,就会对程序中某些自定义的方法或者整个代 码的层次结构都会有很好的了解,对代码的清晰阅读起到很重要的作用， 而且有时候自己遗忘 了某些方法,也可以查阅此 api 文档从而使自己更加清晰各种变量或者方法的意义。

   对于以后的开发工作来说,规范 api 书写，将是一个很好的编程习惯。 现在很多 IDE 都可以直接生成API文档。

我们知道Java中有三种注释语句：

1.//用于单行注释。

2./*...*/用于多行注释，从/*开始，到*/结束，不能嵌套。

3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。

javadoc工具能从java源文件中读取/**...*/注释，并能识别注释中用@标识的一些特殊变量，制作成Html格式的类说明文档，生成api文档。

关键词列表:

@author     作者名

@version     版本标识

@param        参数及其意义

@since           最早使用该方法/类/接口的JDK版本

@return         返回值

@throws        异常类及抛出条件

@deprecated         引起不推荐使用的警告

@see           参考类、方法、变量

@override     重写

对于一个java类文件,我们需要四大块javadoc注释，便可生成api文档

1.文件注释

2.类注释

3.属性注释

4.方法注释

生成api文档主流的有三种方法。

1.采用命令行窗口

2.采用eclipse生成

3.采用maven命令生成

参考文档：

http://wenku.baidu.com/link?url=ZWoJXGZYv2uDYhoY1bZiKN4PbsK_vFu-Hcjrzzyu3AJ6KRYdbDrGefxLEbjBDmpA6NnKvjY2cnRbtKhOD6dJBAsNLvcQdPBhElIS-MYgTsm