Java基础12：使⽤Javadoc命令⽣成⽂档
⼀、Java⽂档注释
Java ⽀持三种注释⽅式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。说明注释允许你在程序中嵌⼊关于程序的信息。你可以使⽤ Javadoc ⼯具软件来⽣成信息，并输出到HTML⽂件中。
⼆、⽂档注释的格式
/**
* .........
* .........
*/
在开始的 /** 之后，第⼀⾏或⼏⾏是关于类、变量和⽅法的主要描述。
之后，你可以包含⼀个或多个各种各样的 @ 标签。每⼀个 @ 标签必须在⼀个新⾏的开始或者在⼀⾏的
开始紧跟星号(*)，其中常⽤的标签如下
标签描述⽰例
@author标识⼀个类的作者@author description
@version指定类的版本@version info
@param说明⼀个⽅法的参数@param parameter-name explanation
@return说明返回值类型@return explanation
下⾯是⼀个类的说明注释的实例:
/** 我的数组帮助类
*定义⼀个⽤于操作数组的⼯具类。
*⽐如：获取最值，排序，折半。
*@author 张三
*@version V1.0
*/
public class ArrayTool
{
/**
该类的空参数构造函数。
*/
private ArrayTool(){}
/**
获取int数组的最⼤值。
@param arr ⽤于接收⼀个int类型的数组。
@return 返回该数组中的最⼤值。
*/
public static int getMax(int[] arr)
{
int max = arr[0];
for(int x=1; x<arr.length; x++)
{
if(arr[x]>max)
max = arr[x];
}
return max;
}
/**
对int数组进⾏从⼩到⼤的排序。java修改html文件
@param arr ⽤于接收⼀个int类型的数组。
*/
public static void bubbleSort(int[] arr)
{
}
}
三、使⽤javadoc⽣成⽂档
javadoc  参数    java⽂件
例如 命令：
javadoc -d ⽂档存放⽬录 -author -version 源⽂件名.java
这条命令编译⼀个名为"源⽂件名.java"的 java 源⽂件，并将⽣成的⽂档存放在"⽂档存放⽬录"指定的⽬录下，⽣成的⽂档中 index.html 就是⽂档的⾸页。-author 和 -version 两个选项可以省略
四、测试⽰例
1、在IDEA到需要⽂档注释的类的地址
选中类，按⿏标右键，选择 show in explorer
2、在地址栏输⼊cmd空格 进⼊Dos窗⼝
3、输⼊javadoc命令，⽣成⽂档注释⽂件
javadoc -encoding  UTF-8  -charset  UTF-8  Doc.java
4、回到类⽬录，到index.html⽂件，打开⽂件

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。