一、什么是注释？
注释是对于代码段的文字介绍，是注释是编写程序时，写的人给一个语句、程序段、函数等的解释或提示，作用是提高代码的可阅读性。可以帮助编程人员更好的阅读其他人或者多年后的自己阅读程序代码。
变成写注释是一个程序员要养成的良好习惯。
二、注释种类
| 行注释 | // 当前行，反斜杠后的文字不会被编译执行 |
| 块注释 （多行注释） | 当前文本，在两个注释标志符之间的内容不会被编译执行，后一个“*/”会匹配最靠前的那个“结束，每一行都要有一个*开始。文档注释的功能更加强大。 |
如图：蓝色部分为文档注释，绿色部分为行注释
三、文档注释
javadoc用于描述类或者方法的作用。Javadoc可以写在类上面和方法上面。
1、写在类上注释：
写在类上的文档标注一般分为三段：
- 第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
- 第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
- 第三段：文档标注，用于标注作者、创建时间、参阅类等信息
2、写在方法上的注释：
写在类上的文档标注一般也分为三段：不同的是第三段一般用于用于标注方法的参数、返回值、异常、参阅等
3、java标签：
javadoc标签：Javadoc注释由Javadoc标签和描述性文本组成，你可以为类、接口添加注释，也可为构造函数、值域、方法等类中的元素添加注释。java的标签以@开头，是JDK定义好的：
标签的种类：
javadoc 标签_Whtai-的博客-CSDN博客_javadoc标签
各类标签的详细用法：
Javadoc 使用详解_vbirdbest的博客-CSDN博客_javadoc
4、HTML帮助文件：
eclipse：eclipse一般会直接生成HTML帮助文件，存储在项目文件夹——>doc下
idea：可查看：在 IntelliJ IDEA 中为自己设计的类库生成 JavaDoc - 小侠猫猫球 - 博客园
dos命令行生成HTML帮助文件的方法：
//javadoc -d 文件夹名 -xx -yy comment.java
-d 文件夹：生成目标文件夹。
-xx，-yy。。。：表示生成的对应的标签。
comment.java：目标文件名和种类
四、java代码的规范
代码规范的作用是方便未来程序的维护和程序的适配性。降低程序维护成本、提高兼容性。
java代码的规范，非常的多，完整版自行下载：
阿里巴巴Java开发手册（全册四版）_一只秃头的小鬼.的博客-CSDN博客_阿里巴巴开发手册
推荐在学完java的基础内容后再看
当前阶段我们能使用到的规范有：
1、类和方法的注释要用文档注释进行。
2、行注释和块注释的作用是提供给代码维护者，帮助其更好地维护、修改、注意什么问题等。
3、善于使用tap和shift+tap，来保证代码的整洁
注：选中你需要移动的代码块，按动tap和shift+tap整体左右移动。
4、运算符左右各自打一个空格。
5、行宽不得超过80
6、源代码默认utf-8。
7、代码编写风格统一：行尾风格和次行风格
注：行尾风格是指前大括号的位置在语句行尾，次行风格是指前大括号在语句行的下一行。
如图：左为次行风格，右为行尾风格
