1.写一个工具类
2.对这个工具类加文档注释
3.用工具解析文档注释
javadoc工具
格式;javadoc -d 目录 -author -version ArrayTools.java
目录;可以写一个文件夹的路径,如果只写了文件名就生成在当前文件路径下
-author:读取包含@author段
-version:读取包含@version段
/**
这是一个简单的数学工具类,提供基本的加减乘除运算
@author Henson_z
@version v1.0
*/
public class MyMath {
/**
把构造方法私有化,可以防止用户创建对象,文档解析不会解析该条方法,因为是private
*/
private MyMath() {
}
/**
计算两个整数之和
*/
public static int add(int a, int b) {
return a + b;
}
/**
计算两个整数之差
*/
public static int minus(int a, int b) {
return a - b;
}
/**
计算两个整数之积
*/
public static int multiplication(int a, int b) {
return a * b;
}
/**
计算两个整数之商
*/
public static int divide(int a, int b) {
return a / b;
}
}