Java注释
定义
注释:用于注解说明解释程序的文字就是注释。
注释的作用
- 提高了代码的阅读性。
- 调试程序的重要方法。
- 注释是一个程序员必须要具有的良好编程习惯。
- 将自己的思想通过注释先整理出来,再用代码去体现
Java中的注释类型:
单行注释
格式:
//注释文字
多行注释
格式:
/* 注释文字 */
注:
- 对于单行和多行注释,被注释的文字,不会被JVM(java虚拟机)解释执行。
- 多行注释里面不允许有多行注释嵌套
文档注释 (java特有)
格式:
/**
* @author 指定java程序的作者
* @version 指定源文件的版本
* ...
*/
作用
- 注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。
操作方式
javadoc -d mydoc -author -version 原文件名.java
- 可以在IDE工具中,显示类后者方法其对应文档注释的基本信息。
正确使用注释和注释风格
- 使用文档注释来注释整个类或整个方法。
- 如果注释方法中的某一个步骤,使用单行或多行注释。