编写注释的原因
编写程序时总需要为程序添加一些注释，用以说明某段代码的作用，或者说明某个类的用途、某个方法的功能，以及该方法的参数和返回值的数据类型及意义等。
通过注释可以提高程序的可读性，使 Java程序的条理更加清晰，易于区分代码行与注释行。另外通常在程序开头加入作者，时间，版本，要实现的功能等内容注释，方便后来的维护以及程序员的交流。
编写注释的原因及意义如下
1、为了更好的阅读自己编写的代码
即使是自己写的代码，如果没有任何代码注释，可能过一段时间回顾的时候，甚至连自己也不记得当时为何这样写代码，需要修改时可能会花较长时间先理解自己写的代码。这个时候，如果养成好的写代码注释习惯，详细的代码注释就起到了很好的帮助作用，甚至可以提高你的开发效率哦。
2、可读性第一，效率第二
现在的软件项目很少单兵作战，一般都是一个团队协同作战开发出来的，而且程序员大部分时间并不是在编写代码，而是在读代码，特别是读别人写的代码。为何呢，因为公司绝大部分的软件项目都不是新项目而是维护项目，所谓维护项目也就是前人已经写好了代码，你需要做的就是在上面修改或添加一些新功能。
因此，就要求团队中一个人写的代码，需要被整个团队的其他人所理解，也就是所谓的代码可阅读性。代码的可阅读性在团队中非常重要，它是衡量代码质量的标准之一，也是体现新老程序员的编码水平的差异。
3、注释即文档
注释是程序文档的重要组成部分，通过 Java 专门的文档注释可以自动生成程序文档，它可以有助于程序的维护。
常用标签
@author 作者
@param 方法的参数
@return 输出参数说明/返回值
@since JDK版本
@version 版本号
@see 链接目标
@throws 异常
@deprecated 解释
@link 链接地址
注释的语法规则
编写Java中的注释不会出现在可执行程序中。因此，可以在源程序中根据需要添加任意多的注释，而不必担心可执行代码会膨胀。在 Java 中，有三种书写注释的方式。
1、单行注释：是最常用的注释方式，其注释内容从 "//"开始到本行末尾
public class Example {
public static void main(String [] arg){
//数据类型转换
byte a = 12;
int b = a; //小范围数据可直接复制给大范围，大范围不能直接赋值给小范围
System.out.println(b);
}
}
2、多行注释：注释内容放到 "/*" 和 "*/"之间。也即是，注释从 "/*" 开始，到 "*/" 结束 ( 需要注意的是，多行注释 "/*"、"*/" 不可以嵌套 )
public class Example {
public static void main(String [] arg){
/* Java 数据类型转换有两种：
一种是自动类型转换
一种是强制类型转换
*/
byte a = 12;
int b = a;
System.out.println(b);
}
}
3、文档注释：Java 语言提供了专门用于生成文档的注释。文档注释是以 "/**" 开始，以 "*/"结束的
public class Example {
/**
* 程序入口方法
* @param args 参数列表
*/
public static void main(String [] arg){
byte a = 12;
int b = a;
System.out.println(b);
}
}
下面使用 JDK 中的 javadoc 命令，来生成 Java 的 API 文档，如下：
1、Win + R 输入 cmd 进入 dos 命令窗口
2、输入 javadoc 命令：javadoc -d docs Example.java
注释的使用细节
三种注释可以出现在程序的任何地方，但是不推荐任意位置。
1. 编程习惯
-
给那条语句进行说明，注释应该写在该语句的旁边。
-
单行注释一般写在语句的后面，多行注释和文档注释一般写在语句的上面
注意：文档注释只能出现在类、属性、方法的上面
2. 注释的嵌套
-
单行注释可以在单行注释里面
-
多行注释不能嵌套在多行注释里面
3. 注释的调试作用
-
可以作为初学者的调试方式
-
可以帮组初学者确定代码的错误之处