12_Java筑基之注释

12_Java筑基之注释

一. Java中的注释

1. 注释的作用

定义: 用于帮助解释说明程序代码的文字就是注释;
特点: 提高了代码的可读性.

2. Java注释分类(3种)

1. 单行注释: 
   语法: //这里是单行注释 

2. 多行注释:
    语法:
    /* 这里是多行注释,
      可以占据多行.
    */
    
3. JavaDoc文档注释: 
    用来注释类、属性和方法等的使用语法.
    语法:
    /** .....*/ 

3. 示例代码

/**
* 这是文档注释:
* 学校类
* @author 一一哥
* @version 2.0 2018/03/20 */
public class School{
    /*
      接下来我们要讲解Java中注释的作用:
      注释有3种.
      这是一个多行注释....
    */

    //单行注释: 学校名称
    String schoolName;

    /**
    * 文档注释:
    * 招生方法
    * @return total 
    */
    public void drawStudent(){ 
        System.out.println(schoolName+"开始招生...");
    }
}

4. 注意:

1. 对于单行和多行注释,被注释的文字,不会被JVM(Java虚拟机)解释执行,也就是不会被编译到.class字节码文件中. 所以即使添加再多的注释,编译后生成的class文件占用的硬盘字节大小不变.

2. 对于文档注释,它是Java特有的注释,其中的注释内容可以被JDK提供的工具javadoc所解析,从而生成一套以网页文件形式展现的该段代码的说明文档.

3. 注释是一个程序员应该具有的良好编程习惯,初学者应该养成编写程序注释的习惯.

4. 单行注释中可以嵌套单行注释,单行注释中也可以嵌套多行注释;

5. 多行注释中可以嵌套单行注释,但是多行注释中不能嵌套多行注释. 因为多行注释的开头会和被嵌套的多行注释的结尾配对,导致后面的注释失效.

6. 可以使用注释对代码中的错误进行定位:
   方法: 当程序运行报错时, 将某些代码注释掉,然后重新编译,运行. 如果程序不再报错,那么说明被注释掉的部分代码中有错误.

5. 文档注释作用:

1. 编写代码时可通过提示显示文档注释;
2. JavaDoc能够从源代码中抽取类、属性、方法等的注释,形成一个配套的API帮助文档.

6. 演示: eclipse生成帮助文档

注意编码: -encoding utf-8 -charset utf-8 

在命令行中执行如下命令:

javadoc -d doc -encoding utf-8 -charset utf-8 src\com\syc\demo\Person.java

7. JavaDoc常用标签