java中的注释
目录
种类
1. 单行注释(//)
//下面是一段标准代码 public class HelloWorld{ public static void main(String[] args){ System.out.println("HelloWorld!"); } }
2. 多行注释(/* */)
多行注释中可以嵌套单行注释。
3. 文档注释(/** */)
文档注释是对一段代码概括的解释说明,可以使用javadoc命令将文档注释提取出来生成帮助文档(自定义类对应的API)。
例:原文档
javadoc命令提取文档注释
生成帮助文档
帮助文档内容展示:
作用
1. 注释就起到了标注解释的作用,提高代码的可读性。
2. 方便代码的调试:将错误的注释掉。