1. JavaDoc概述
JavaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
Java中有三种注释方法:// 单行注释、/* 多行注释*/ 和 /**文档注释 */,其中第三种专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。我们可以通过Eclipse来实现Java文件的API文档生成。
2.文档注释的格式
Javadoc生成的文档是HTML 格式,而这些HTML格式的标识符并不是javadoc添加的,而是我们在写注释的时候写上去的。使用文档注释时,我们应该合理的使用块标记来添加注释信息,常用的块标记包括:
-
@author 标明开发该类模块的作者
-
@version 标明该类模块的版本
-
@see 参考转向,也就是相关主题
-
@param 对方法中某参数的说明
-
@return 对方法返回值的说明
-
@exception 对方法可能抛出的异常进行说明
【示例】使用块标记实现文档注释案例
/**
* Student类
* @author 程序猿
* @version 2.3.1
*/
public class Student {
/**
* 学生名字
*/
private String name;
/**
* 学生姓名
*/
private