注释
什么是注释
注释就是源文件中用于解释、说明程序的文字
程序员最讨厌的两件事:
自己写代码被要求加注释
接手别人的代码,发现没有注释
注释的作用
- 提高代码可读性
- 便于代码维护和更新
- 自动生成API文档(仅限于javadoc注释,下面会介绍)
注释的类型
- 单行注释java
// 这是一个单行注释,以两个斜线为标志
- 多行注释java
/* 注释内容 注释内容 注释内容 */
- 文档注释(javadoc注释)java说明:文档注释内容可以被 JDK 提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。
/** * @author java程序的作者 * @version 源文件的版本 * …… */