程序中的每个指令都是程序员面向计算机发出的“命令”，只要语法正确，计算机就按照“命令”进行执行。但是，在实际工程项目中，一个人往往要写好几千行代码，一个团队之间也需要进行代码的维护、管理和升级。因此，为了防止因务业规模扩大和复杂化导致代码不好维护，故而采用注释来解释源代码的功能。
注释知多少？
-
什么是注释？有什么用？
注释是对java源代码的解释说明。
注释可以帮助程序员更好的理解程序。
它是编写程序 时，写程序的人给一个语句、程序段等的解释或提示，能提高程序代码的可读性。
-
注释信息只保存在java源文件当中，java源文件编译生成的字节码class文件， 这个class文件中是没有这些注释信息的。
-
在实际的开发中，一般项目组都要求积极的编写注释，这也是一个java软件工程师的基本素养。
-
注释不是越多越好，精简、主线清晰、每个注释都应该是点睛之笔。
Java代码中注释三种方式
Java代码中注释分为三种类型，分别是：单行注释、多行注释和文档注释。
- 单行注释
过两个连续的斜杆（“//”）将单行后面出现的内容进行注释。
单行注释一般用于方法内部某行代码的解释说明。
== 在IDEA中的快捷键是<ctrl + />，再次按下将撤销注释。==
- 多行注释
采用（“/…/”）
多行注释可用于修改记录标记、复杂代码块的实现说明等场景。
== 在IDEA中的快捷键是<ctrl + shift + />，再次按下将撤销注释。==
- 文档注释
采用（“/**…*/”），看上去跟多行注释没什么区别。不同点在于
使用“javadoc”工具（JDK自带的工具）来生成信息，并输出到HTML文件中。常常用于类、方法、属性、常量、接口、静态数据的说明，同时提供了很多预定义标签，用“@”符号开始。编写程序的时候有一套特定的标签作为注释，程序编写完成后，通过“javadoc”就可以同时形成程序的开发文档了。
随着Java学习深入，对于文档注释的使用场景会越来越清楚。
通过IDEA提供的“javadoc”生成功能可以方便、直观地得到文档注释的输出效果，接下来说明一下操作步骤。
首先，如图所示：
在“Generate JavaDoc”对话框中进行相关配置，
如上图中标记为1：选择了单个文件；标记为2：制定了输出HTML文件（网页文件）的路径；标记为3：勾选了文档注释的标签；标记为4：填写向“Javadoc.exe”程序传递的参数。参数需要写在一行，为了方便解释以换行形式展示。
-encoding UTF-8 ：表示源代码是基于UTF-8编码的，以免出现乱码；
-charset UTF-8 ：表示在处理并生成网页文档时使用的字符集也是以UTF-8进行编码；
-windowtitle “测试文档注释” ：表示生成的网页文档在浏览器中打开时浏览器窗口标题栏要显示的文字；
-link https://docs.oracle.com/en/java/javase/11/docs/api：表示如果要生成文档会涉及对外部Java类的引用，可以直接指向官方的API详细文档地址。
网页文档打开后的部分预览效果。
在IDEA中的快捷键是</**>，再按键即可。