Java技术之注释

注释是Java程序中,编译器过滤的部分,编译器不会对注释的部分进行预编和编译等操作,相当于记个备注,但不影响程序的使用,有利于后期维护和提升代码的可读性javadoc帮助生成注释文档,这一点如果需要制作文档才需要

注释的作用

通过下面两段代码对比即可知晓使用注释的好处

public class Circular {
    public static void main(String[] args) {
        int r=3;
        double C=2*Math.PI*r;
        double S=Math.PI*r*r;
        System.out.println(C);
        System.out.println(S);
        //输出结果
        //18.84955592153876
        //28.274333882308138
    }
}

好像上面代码并不能看出什么,我们进行如下修改

public class Circular {
    public static void main(String[] args) {
        //定义一个圆的半径r为3
        int r=3;
        double C=2*Math.PI*r;//圆的周长=2π*r
        double S=Math.PI*r*r;//圆的面积=πr^2
        System.out.println(C);//周长
        System.out.println(S);//面积
        //输出结果
        //18.84955592153876
        //28.274333882308138
    }
}

通过上面的代码,清楚的明白如下信息

• 本次Circular类执行的是一个圆的周长和面积的计算

• r为半径3

• 周长为C,C通过公式计算

• 面积为S,S通过公式计算

注释的扩展

• 单行注释

• 多行注释

• 文档注释

类块和方法块一般由“{”开始,“}”结束实际开发并不是注释越多越好哦,本例只是把每个知识点注释说明清楚日常开发例如计算一个圆的周长或面积,只需要注释两段公式即可,其他无需过多说明,公认的知识点大家都认可和知道

/**
* 类注释
* 也可以叫文档注释
* 定义一个类名为Circular的类文件,类文件和类名必须一致,类文件以.java作为后缀,编译以后的文件为.class文件
 * @author twoapes  此处说明作者
*/
public class Circular {//类块开始
    /**
     * 定义一个name作为整个类的全局静态变量
     *域注释
     */
    private static String name;
    /**
     * @param args 定义了一个String[]对象参数 此处对参数进行说明
     * @deprecated 程序入口 此处建议程序一般不要使用此方法,main方法一般用于程序的执行入口,不要在每个类中都定义这样的方法
     *Java区分大小写,所以main千万不要写成Main哦
     */
    public static void main(String[] args) {//方法块开始
        //定义一个园的半径r为3  单行注释
        int r = 3;
        double C = 2 * Math.PI * r;//园的周长=2π*r
        double S = Math.PI * r * r;//园的面积=πr^2
        System.out.println(C);//周长
        System.out.println(S);//面积
        /* 多行注释,也叫块注释
        输出结果
        18.84955592153876
        28.274333882308138
        */
    }//方法块结束
}//类块结束