注释并不会被执行，是给我们写代码的人看的

书写注释是一个非常好的习惯

注释分类：

  1. 单行注释
    使用符号“//”开头，注释“//”后面的内容
  2. 多行注释
    使用符号“/* */”，可以注释一段文字，注释两个星号之间的内容
  3. 文档注释
    使用符号“/** */”

注释的作用：

  1. 对程序进行解释说明：要求代码中，有30%的行数都用来写注释
  2. 对程序的思路进行描述
  3. 对程序进行调试：通过注释的方式，快速定位出现错误的代码位置

javadoc命令是用来生成自己API帮助文档的
javadoc -encoding UTF-8 -charset UTF-8 xxx.java
参数信息：

  • @author 作者名
  • @version 版本号6
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

加在类上就是类的注释，加在方法上就是方法的注释

通过命令行生成帮助文档 javadoc 参数 java文件