java学习笔记-注释

注释

为了方便程序的阅读，Java语言允许程序员在程序中写上一些说明性的文字，用来提高程序的可读性，这些文字性的说明就称为注释。

注释不会出现在字节码文件中，即Java编译器编译时会跳过注释语句。

在Java中根据注释的功能不同，主要分为单行注释、多行注释和文档注释。

• 单行注释

单行注释使用“//”开头，“//”后面的单行内容均为注释。

• 多行注释

多行注释以“/*”开头以“*/”结尾，在“/*”和“*/”之间的内容为注释，我们也可以使用多行注释作为行内注释。但是在使用时要注意，多行注释不能嵌套使用。

• 文档注释

文档注释以“/**”开头以“*/”结尾， 注释中包含一些说明性的文字及一些JavaDoc标签（后期写项目时，可以生成项目的API）

单行注释和多行注释

1. //下面是一段标准代码
2. //这是代码的“框子”，当前阶段你可以当做一个模板
3. //其实这就是一个类，类的名字是HelloWorld，这个名字可以随便起，但是一般首字母大写，驼峰命名，见名知意
4. public class HelloWorld{
5.         //下面是一个main方法，方法的格式是固定的
6.         public static void main(String[] args){
7.                 //下面这句话的作用：将双引号中的内容进行原样输出
8.                 /*
9.                 这是多行注释
10.                 每行都可以写
11.                 单行注释和多行注释，按照你自己的需求去使用即可
12.                 */
13.                 System.out.println("hi....java");
14.         }
15. }

注意：

1.注释不会参与编译，编译后产生的字节码文件中不会有注释的内容

2.注释的作用：

（1）注释就起到了标注解释的作用，提高代码的可读性，方便自己，方便他人--》是一个非常良好，非常专业的习惯！！！

（2）方便代码的调试：

1. public class HelloWorld2{
2.         public static void main(String[] args){
3.                 System.out.println("hi....java1");
4.                 //System.out.println("hi....java2")
5.                 System.out.println("hi....java3");
6.         }
7. }

文档注释

1. /**
2. 文档注释
3. @author zhaoss
4. @version 1.0
5. 这是我们第一章文档注释的代码，比较重要
6. */
7. public class HelloWorld3{
8.         public static void main(String[] args){
9.                 System.out.println("hi....java1");    
10.         }
11.         /**
12.         @param name 姓名
13.         @param age 年龄
14.         */
15.         public void eat(String name,int age){
16.                 System.out.println("hello");  
17.         }
18. }

一般文档注释可以配合：jdk提供的工具javadoc.exe来一起使用，通过javadoc.exe可以对文档注释进行解析，生成一套以网页文件形式体现的该程序的说明文档。（自定义类对应的API）