1、注释的作用

  在Java开发中,代码不仅仅是给你自己看的,还有其他的开发人员一起阅读,因此良好的注释习惯会给自己和他人很好的便利。此外,即使是自己写的代码,如果不加注释,时间一久也会忘记,又需要花费时间去阅读代码。在程序中,尤其是复杂的程序中,适当地加入注释可以增加程序的可读性。注释的内容在程序编译的时候会被忽视,不会产生目标代码,注释的部分不会对程序的执行结果产生任何影响。

2、注释的分类

单行注释: // 注释文字
多行注释: / 注释文字 /
文档注释:/ 注释文字 */

3、帮助文档生成命令

javadoc -d target -author -version source
javadoc : JDK的一个命令,生成帮助文档
-d : 表示目录的意思生成的帮助文档会存放在一个目录(文件夹)下
target : 存放操作手册文档的目录
author : 表示操作手册中会生成作者
version : 表示操作手册中会生代码版本
source:存放源文件


有错误的地方敬请指出,欢迎大家评论区或者私信交流!每日持续更新Java、Python、大数据技术,请大家多多关注!