文档注释 javadoc

选择菜单栏上project-->Generate Javadoc  可以生成注释HTML

 

（1）在基于Java的软件项目开发中，设计者通过Java文档注释向实现者阐述类的编写要求。Java将注释和源码放在同一个文件中，这样做可以保证源码和注释版本的对应性。Java提供了javadoc命名从源代码中提取文档注释内容并生产HTML格式的文档。
（2）Java文档注释内容被放到/**  */之间，在内容中可以使用@开始的若干标记，这些标记代表特殊的含义，能够别javadoc命令识别。

 

（3）注释的插入  - Java文档注释可以用来说明一下信息：
包
public类
public和protected方法
public和protected属性

例如：

package ez.corejava.comments;
/**
* Java文档注释举例。
* 
* @author Teacher
* @version1.0
*/
public class JavaDoc {
/** 分页显示的每页显示件数*/
public static final int ROW_PER_PAGE = 10;
/**
* 计算两个整型数字之和。
* 
* @param n1 被加数
* @param n2 加数
* @return 给定数字相加的结果。
*/
public int add(int n1, int n2){
    return  n1 + n2;
}
} 

 

/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。

第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行

简述也在其中。这一点要记住了

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值

 

三. 使用 javadoc 标记
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些：
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

@author 作者名
@version 版本号
其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次，只有第一次有效

使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。它们的句法如下：
@param 参数名参数说明
@return 返回值说明
@exception 异常类名说明