Java注释

Java注释

什么是注释？

源文件中用于解释、说明程序的文字就是注释。

Java中的注释类型：

单行注释：

//注释文字

多行注释：

/*
注释文字
...
...
*/

文档注释：

/**
  @author  指定java程序的作者
  @version  指定源文件的版本
*/

注释的作用

• 他提升了程序的可阅读性。

• 调试程序的重要方法。

使用方法

1.单行注释、多行注释：

• 对于单行和多行注释，被注释的文字，不会不会出现在字节码文件中，进而不会被JVM（java虚拟机）解释执行。

• 多行注释里面不允许有多行注释嵌套。

2.文档注释

• Java独有

• 文档注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。

• 操作方式。比如：

  javadoc -d mydoc -author -version HelloWorld.java