Java：API文档；文档注释中的javadoc标记；官方API；自己动手给项目建一个API文档

1、什么是API文档

在Java语言中有3种注释

//单行注释
/*
   多行注释
 */
/**
 * 文档注释
 */

API（应用程序接口）文档就是用javadoc命令提取文档注释生成的，html格式，用浏览器查看。

API文档既然是由文档注释生成的，那么文档注释怎么写呢？

首先，文档注释必须放在类和方法的前面，格式也要准确。

其中，要写清楚类和方法的功能，以及方法传入的形参和返回值具体是什么。

一般来说，只默认提取public和protected修饰的类、接口、方法、成员变量、构造器、内部类的说明。

2、文档注释中的javadoc标记

@author	程序作者	类/接口的文档注释中
@version	程序版本	类/接口的文档注释中
@param	方法参数说明	方法/构造器的文档注释中
@return	方法返回值说明	方法/构造器的文档注释中
@exception、@throws	抛出的异常	方法/构造器的文档注释中

3、官网下载

打开index.html：

4、自己创建一个API文档

javadoc -d apidoc -windowtitle 测试 -doctitle JavaSE学习 -header 侧栏名字 -author basicGrammar/*.java designPatterns/*.java

• -d ：输出文件的目标目录
• -windowtitle ：文档的浏览器窗口标题
• -doctitle ：概览页面的标题
• -header ：每个页面的页眉文本
  
  
• -author：包含 @author 段
• -version：包含 @version 段