Javadoc工具的使用

Java提供了Javadoc工具，通过这个工具可以使你编写的代码生成一份API文档，前提是你已经为你的程序提供了文档注释。

下面Javadoc工具使用的步骤：

1. 在你的代码中添加文档注释

   public class MyAPI {
   
   	/**
   	 * 计算两个整数的和
   	 *
   	 * @param a 第一个整数
   	 * @param b 第二个整数
   	 * @return 两个整数的和
   	 */
   	public static int add(int a, int b) {
   		return a + b;
   	}
   
   	/**
   	 * 除法运算
   	 *
   	 * @param a 被除数
   	 * @param b 除数
   	 * @return 商
   	 * @throws ArithmeticException 如果除数为0
   	 */
   	public static int divide(int a, int b) throws ArithmeticException {
   		if (b == 0) {
   			throw new ArithmeticException("除数不能为0");
   		}
   		return a / b;
   	}
   }
   

2. 使用Javadoc命令生成API文档。

   javadoc -d [输出目录] [包名]
   

   
   便可以在doc目录下找到以当前类名命名的.html文件。