学习笔记：day02 Java中的三种注释

2022-10-15 14:13:46

注释

注释不会被当作代码执行，只是对代码的一个解释，给看代码的人看，好的注释会提高代码易读性

书写注释是一个非常好的习惯

1.单行注释

单行注释顾名思义，即只有一行的注释，使用//开头，单行注释只能包含一行注释文本

//输出Hello World
System.out.println("Hello World");

2.多行注释

以/*开头，以*/结尾，中间可包含多行注释文本

/*
这
是
多
行
注
释
*/

3.文档注释

Javadoc是用来生成api文档，以/**开头，以*/结尾

参数

命令	说明
@author	作者名
@version	版本号
@since	指明需要最早使用的jdk版本
@param	参数名
@return	返回值情况
@throws	异常抛出情况

/**
 * @author aji <---作者名
 * @version 1.0  <---版本号
 * @since 1.8 <---需要最早的jdk版本号
 */
public class JavaDoc {
    /**
     *
     * @param name  <---参数
     * @return  <---返回值
     * @throws Exception <---异常抛出
     */
    public String test(String name) throws Exception{
        return name;
    }
}