(二)注释（comment）详解

目录

前言：  

一、注释类型（三种）

        二、单行注释和多行注释的作用

        三、特点

        四、文档注释的使用

        五、多行注释注意点

        六、良好的编码风格

前言：  

        注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

        注释只是为了提高可读性，不会被计算机编译。

一、注释类型（三种）

        1.单行注释：//内容

        2.多行注释：      

         /*
           内容1
           内容2
        */

        3.文档注释(java特有)：

  /**
   @author 指定Java程序的作者
   @version   指定源文件的版本
   */

        二、单行注释和多行注释的作用

                1.对所写的程序进行解释说明，增强可读性。方便自己，方便别人；

                2.可以调试所写的代码；

        三、特点

                单行注释和多行注释，注释了的内容不参与编译（编译生成的.class结尾的字节码文件不包含注释掉的信息）。

        四、文档注释的使用

                注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档。

        文档注释操作方式

                生成文档注释解析：

javac	-d	-author	-version	helloword.java

        五、多行注释注意点

                多行注释不可以嵌套使用

        六、良好的编码风格

                （1)正确的注释和注释风格：

                        使用文档注释来注释整个类或整个方法；

                        如果注释方法中的某一个步骤，使用单行或多行注释

                (2)正确的缩进与空白：

                        使用一次tab操作，实现缩进；

                        运算符两边习惯性各加一个空格。

                (3)块的风格(Java API源代码选择了行尾风格)

                        1.行尾风格

                        2.次行风格
           

public class Test {
    //行尾风格
    public static void main(String[] args) {
        System.out.println();
    }
}

public class Test 
{
    //次行风格
    public static void main(String[] args)
    {
        System.out.println();
    }
}