Java-API文档制作

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;
	}
}
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值