java中的文档注释和制作
在eclipse使用时，可以配合文档注释，导出对类的说明文档，从而供其他人阅读学习与使用。
通过使用文档注释，将类或者方法进行注释用@简单标注基本信息。如@author 作者、@version代码版本、@param方法参数、@return方法返回值等。
package cn.littlestar;
/**
* 我的工具类
* @author little_star
* @version 1.0版本
*/
public class Tool {
/**
* 返回两个整数的累加和
* @param num1 第一个数
* @param num2 第二个数
* @return 返回累加和
*/
public static int getSum(int num1, int num2){
return num1 + num2;
}
}
使用Eclipse导出javadoc文档即可，操作步骤如下图：