javadoc注释

javadoc注释

// 注释一行 
/* ...... */ 注释若干行 
/** ...... */ 注释若干行，并写入 javadoc 文档 

类注释：

/**
 * 一句话功能描述
 * 功能详细描述
 * @author [作者] 必须
 * @version 版本号
 * @see [相关类/方法] (可选)  查看相关内容，如类、方法、变量等。
 * @since [产品/模块版本] (必须) API在什么程序的什么版本后开发支持
 * @deprecated 可选  标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API
 */

函数注释：

/**
 * 一句话功能描述
 * 功能详细描述
 * @param [参数1] 参数1说明
 * @param [参数2] 参数2说明
 * @return [返回类型说明]
 * @exception/throws [异常类型] [异常说明]
 * @see [类、类#方法、类#成员]
 * @since [起始版本]
 * @deprecated (可选)
 */

异常的注释

/**
 * 关闭当前数据流
 * @throws IOException 当关闭流失败时抛出该异常
 */

用@exception表示Runtime异常，@throw标注非Runtime异常

private String javaDocTest() throws IOException{

cmd命令
javadoc xxx.java

或者Eclipse
对着项目右键 Export->java->javadoc->next->选择存放路径
即可 对整个 项目作API文档生成

打开index.xml即可