【Java注释:单行 多行 文档注释】

Java注释:单行 多行 文档注释

注释是程序语言的说明,它有助于开发者之间的交流,方便解释程序.

注释在程序语言中不会被视作代码,不会执行,而被编译器忽视.

Java中,注释可分为三类

1.单行注释

以双斜杠杠"//"为标识,但是智能注释一行内容,用于注释信息内容较少的情况,不使用于注释大幅度的文章

 //输出稀疏数组
        System.out.println("稀疏数组");

        for (int i = 0; i < array2.length; i++) {
            for (int j = 0; j < array2[i].length; j++) {
                System.out.print(array2[i][j]+"\t");
            }
            System.out.println();
        }

2.多行注释

由"/* */"和包裹起来的注释为多行注释,适用于注释文字幅度篇幅较大的情况

注:多行只是可以嵌套单行注释,但不能嵌套多行注释和文档注释

 System.out.println("元素个数："+collection.size());
        System.out.println(collection);
        //删除元素
        /*collection.remove("榴莲");
        System.out.println("删除之后："+collection.size());
        System.out.println(collection);
        collection.clear();
        System.out.println("清空之后："+collection.size());*/
        //遍历元素【重点】
        //第一种方式 使用增强for
        for (Object object:collection) {
            System.out.println(object);
        }

3.文档注释

包含在"/** */"之间,也能注释多行内容,一般在类,方法和变量上面,用来描述器作用

注:文档注释能嵌套单行注释,不能嵌套多行注释和文档注释,一般首行和尾行也不写注释信息

package com.lin.operator;

public class TestDemo04 {
    /**
     * @author lin
     * @version 2022.1.1
     * @since 1.8
     */
    public static void main(String[] args) throws Exception {
        int i = 10;
        int j = 20;
        String z = i > j ? "i大于j" :"i小于j";
        System.out.println(z);
        TestDemo04 testDemo04 = new TestDemo04();
        System.out.println(testDemo04.circle(testDemo04.radius));
    }

    static final double PI = 3.1415926969;
    double radius = 5.69;

    /**
     * @param radius
     * @return area
     * @param radius
     * @throws Exception
     */
    public double circle(double radius) throws Exception{
        double area = PI * Math.pow(radius,2);
        return area;
    }
}