javase Javadoc注释和生成文档

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

1.//用于单行注释。

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

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

javadoc 工具能从 java 源文件中读取第三种注释， 并能识别注释

中用@标识的一些特殊变量（见表）， 制作成 Html 格式的类说明文档。

javadoc 不但能对一个 java 源文件生成注释文档，而且能对目录和

包生成交叉链接的 html 格式的类说明文档，十分方便。

注释中可以出现的关键字，以@开头：

@author 作者名

@version 版本标识

@parameter 参数名及其意义

@since 最早出现的 JDK 版本

@return 返回值

@throws 异常类及抛出条件

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

@see 交叉参考

例子：

 /**
*汽车类的简介
*汽车类具体阐述第一行
*汽车类具体阐述第二行
*@author man
*@author man2
*@version 1.0
*@see ship
*@see aircraft

*/
public class Bus{
/**
*用来标识汽车行驶当中最大速度
*@see #averageSpeed
*/
public int maxSpeed;
/**用来标识汽车行驶当中平均速度*/
public int averageSpeed;
/**用来标识汽车行驶当中的水温*/
public int waterTemperature;
/**用来标识天气温度*/
public int Temperature;
Bus(){
}
/**
*该方法用来测量一段时间内的平均速度
*@param start 起始时间
*@param end 截止时间
*@return 返回 int 型变量
*@exception java.lang.exceptionthrowwhenswitchis1
*/
public int measureAverageSpeed(int start,int end ){
int aspeed=12;
return aspeed;
}
/**
*该方法用来测量最大速度
*/
public int measureMaxSpeed(){
     return  1 ； 
}
} 

javadoc 命令：

javadoc -d 文档寄存目录 -author -version 源文件名.java