代码添加注释的作用

1. 便于别人阅读代码

2. 代码添加注释后可编译生成文档

2.1 通过cmd命令生成javadoc文档

（1）在cmd命令行输入javadoc -encoding UTF-8 -charset UTF-8 Demo01.java，回车

（2）进到包路径下找index.html文件

（3）打开index.html文件查看javadoc文档

2.2 通过idea的Tools->Generate JAVADoc…生成文档

（1）生成文档

（1.1）Custom scope>>自定义生成文档的范围
（1.2）output directy 生成的文档存放的位置
（1.3）private、package、protected、public 生成文档的级别
（1.4）Locale 语言类型,zh-CN
（1.5）Other command line arguments ：定义编码集 -encoding UTF-8 -charset UTF-8

（2）查看index.html文件

代码添加注释的作用

原文：https://www.cnblogs.com/zhangyaru/p/14732595.html