JAVA基础知识之注释

一、注释概念

        1、注释类似于物品的使用说明书，主要用于进行说明解释或者屏蔽代码，以便代码更易理解

        2、注释部分是不会被程序执行的

二、JAVA注释的方式

       1、// ：单行注释，用于注释单行代码

       2、/*.......... */ : 多行注释，用于注释多行代码

       3、/** .......*/ ：注释文档，用于解释类、方法等作用、参数意义等。

package textCode;

/**
 * 这个是测试类
 * @author Administrator
 *
 */
public class Test
{
    /**
     * 这是测试方法
     * @param args
     */
    public static void main(String[] args)
    {
    
        // System.out.println("单行注释说明");
        
        /* 
         * int a=3;
         * int b=4;
         * System.out.println("多行注释说明");
         * */
    }
}

三、特别注意点

           1、代码中尽量少用单行注释和多行注释，一是视觉不好看，二是太过繁琐（尤其多行注释代码，完全可以删掉代码而不是注释）    

           2、每个类、每个方法都尽量使用注释文本，便于自己和团队快速理解作用