java作业4

一、注释的作用
在编写程序时，为了使代码易于阅读，通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明，它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。
注释只在Java源文件中有效，在编译程序时编译器会忽略这些注释信息，不会将其编译到class字节码文件中。建议大家养成给程序添加必要注释的良好习惯。

二、注释的分类
（一）简单说明
1、单行注释
单行注释通常用于对程序中的某一行代码进行解释，用符号“//”表示，“//”后面为被注释的内容。单行注释既可以放在语句后面，也可以单独占一行。
2、多行注释
多行注释顾名思义就是可以同时为多行内容进行统一注释，它以符号“/”开头，并以符号“/”结尾。注意：可以是一行，也可以是多行。
3、文档注释
文档注释通常是对程序中某个类或类中的方法进行的系统性的解释说明，开发人员可以使用JDK提供的javadoc工具将文档注释提取出来生成一份API帮助文档。文档注释以符号“/**”开头，并以符号“*/”结尾。（软件：程序 + 数据 + 文档）

（二）案例演示
创建c02.s01.p02包，在包里创建Example01类

利用IDEA可以生成项目的API文档

生成的文档在D:\java_work目录里，打开首页index.html即可查看生成的API文档

（三）注释的嵌套
1、简单说明
多行注释“/…/”中可以嵌套使用单行注释“//”。
多行注释“/…/”中不能嵌套使用多行注释“/…/” 。
2、案例演示
在c02.s01.p02包里创建Example02类