二、用于文档注释的注解、以及如何设置如何显示文档注解的时间

用于文档注释的注解

java中的注释:
(1)单行注释
(2)多行注释
(3)文档注释,java特有
需要配合注解使用

用于文档注释的注解
@author
@version
@since

@param
(1)必须该方法有形参,才能写,有几个形参写几个
(2)格式:@param 形参名 形参数据类型 解释

@return
(1)必须方法的返回值类型不是void,一个方法@return最多有一个
(2)格式:@return 返回值类型 解释
@throws

(1)必须方法throws异常,有几个写几个
(2)格式:@throws 类型 解释

如何生成注释文档?
右击方法TestDoc.java文件,选择Export,选择java,选择JavaDoc,选择JDK中的javaDoc.exe文件的位置,
然后选中需要生成的文件,点击next,点击next,在这里需要添加配置文件不然字符编码会有问题的,
添加
-encoding utf-8
-docencoding utf-8
点击finish。

import javax.management.RuntimeErrorException;

/**
 * 
 * @author lenovo
 * @version jdk1.8
 * @since jdk1.8
 *
 */
public class TestDoc {
	/**
	 * 这是主方法,是Java程序的入口
	 * @param args String[] 命令行参数
	 */
	public static void main(String[] args) {
		
	}
	
	/**
	 * 求两个整数的最大值
	 * @param a int 其中一个整数
	 * @param b int 另一个整数
	 * @return int 返回a,b中较大者
	 */
	public static int getMax(int a , int b) {
		return a>b?a:b;
	}
	
	/**
	 * 求两个数的商
	 * @param a int 被除数
	 * @param b int 除数
	 * @return int 商,只保留整数部分
	 * @throws RuntimeException 当除数为0的时候,会抛出异常
	 */
	public static int divide(int a, int b) throws RuntimeException{
		if (b == 0) {
			throw new RuntimeException("除数不能为0");
		}
		return a/b;
	}
	
	
}

如何设置显示日期和时间

window – prefrence – java – code style – code template – comments – type – 插入变量(选择自己想要添加的变量,列如日期时间)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值