Java程序设计实战案例教程
上QQ阅读APP看书,第一时间看更新

2.1.2 Java中的注释

注释是对程序语言的说明,有助于开发者和用户之间的交流,方便理解程序。注释不是编程语句,因此会被编译器忽略。

Java支持以下3种注释方式。

1.单行注释

单行注释以双斜杠“//”标识,只能注释当前行内容,用在注释信息较少的地方,如图2-1所示。单行注释书写方便,所以最为常用。

2.多行注释

多行注释以“/*”和“*/”标识,可以注释多行内容。为了使程序的可读性比较好,一般首行和尾行不写注释信息,如图2-2所示。

图2-1 单行注释

图2-2 多行注释

3.文档注释

文档注释以“/**”和“*/”标识,一般用在类、方法和变量上方,用来描述其作用,如图2-3所示。文档注释可以使用Javadoc工具提取出来,并生成HTML帮助文件。

图2-3 文档注释