Java 注释

引言

Java 支持三种注释方式,分别是单行注释、多行注释和Javadoc文档注释

单行注释

以双斜杠“//”标识,只能注释一行内容,用在注释信息内容少的地方。打开 Eclipse,在 Java 代码中使用单行注释,如图 1 所示。
image-20210728102914258

多行注释

包含在“/”和“/”之间,能注释很多行的内容。为了可读性比较好,一般首行和尾行不写注释信息(这样也比较美观好看),如图 2 所示。
注意:多行注释可以嵌套单行注释,但是不能嵌套多行注释和文档注释。
image-20210728103015327

文档注释

包含在“/**”和“*/”之间,也能注释多行内容,一般用在类、方法和变量上面,用来描述其作用。注释后,鼠标放在类和变量上面会自动显示出我们注释的内容,如图 3 所示。

注意:文档注释能嵌套单行注释,不能嵌套多行注释和文档注释,一般首行和尾行也不写注释信息。
image-20210728103105922

文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档,并输出到 HTML 文件中,方便记录程序信息。还可以包含一个或多个 @ 标签,每个 @ 标签都在新的一行开始。关于 Javadoc 的使用,可以查看Javadoc 注释使用详解

posted @ 2021-07-28 10:34  Binge-和时间做朋友  阅读(160)  评论(0编辑  收藏  举报