重学Java第4天：JavaSE---注释

Java注释

Java中的注释共三种：

1. 单行注释：// 注释内容
2. 多行注释：/*注释内容*/
3. 文档注释：/**注释内容*/

单行和多行注释不演示，只对文档注释详述。

文档注释

文档注释方式如上图所示，其中有很多以@开头的标签，用来描述代码信息：

1. @author 作者名
2. @version 版本号
3. @since 指明需要的最早使用的JDK版本
4. @param 参数名
5. @return 返回值情况
6. @throws 异常抛出情况

通过javadoc.exe对文档注释中的标签内容和代码内容生成html格式的文档，即对.java文件使用javadoc命令。
注意：

1. 源代码注释有中文需要加上-encoding utf-8
2. 生成文档不希望出现乱码要加上-charset utf-8
   
   生成内容在同文件夹下的index.html中可以查看
   注意：有些带@的标签字段被隐藏（比如：@author），需要加上相应的参数（-author）才能显示