Java注释：单行、多行和文档注释

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

Java 支持以下三种注释方式：

1）单行注释

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

图 1 单行注释

2）多行注释

包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观好看），如图 2 所示。

注意：多行注释可以嵌套单行注释，但是不能嵌套多行注释和文档注释。

图 2 多行注释

3）文档注释

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

注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。

图 3 文档注释

文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档，并输出到 HTML 文件中，方便记录程序信息。还可以包含一个或多个 @ 标签，每个 @ 标签都在新的一行开始。关于 Javadoc 的具体标签和使用可阅读学习《Javadoc入门教程》一节。

在 Java 中，一行注释以双斜杠“//”标识；多行注释包含在“/*”和“*/”之间；文档注释包含在“/**”和“*/”之间。当编译器执行到“//”时，就会忽略该行“//”之后的所有文本；当执行到“/*”时，会扫描下一个“*/”并忽略“/*”和“*/”之间的任何文本；当执行到“/**”时，也会扫描下一个“*/”并忽略“/**”和“*/”之间的任何文本内容。

Java注释：单行、多行和文档注释相关推荐

【Java注释:单行多行文档注释】
Java注释:单行多行文档注释注释是程序语言的说明,它有助于开发者之间的交流,方便解释程序. 注释在程序语言中不会被视作代码,不会执行,而被编译器忽视. Java中,注释可分为三类 1.单行注释 ...
Swift 注释规范和文档注释
目录普通注释结构性或者功能提示: MARK.TODO.FIXME 编译器提示文档注释 Playground注释今天,我知道我写是什么,上帝和我知道明天,我知道这个代码什么意思 ...
【Java】浅谈JavaDoc文档注释
JavaDoc文档注释文档注释 JavaDoc标记文档注释示例基于Eclipse IDE的JavaDoc实战后记文档注释我们知道,Java有三种注释: 单行注释:// 多行注释:/* */ ...
java自动化测试语言高级之文档注释
java自动化测试语言高级之文档注释文章目录 java自动化测试语言高级之文档注释 Java 文档注释 Java 文档注释 Java 支持三种注释方式.前两种分别是 // 和 /* /,第三种被称作 ...
javav转义字符“\”和文档注释//
第二天学习 1.转义字符第六个北京会替换掉韩顺,\r会将光标移到第一个字符 2.文档注释
Eclipse文档注释快捷键以及自定义文档注释内容
文档注释快捷键 shift+alt+j 自定义文档注释打开Eclipse--Window--Perference--Java--Code Style--Code Templates--Comment ...
和java通信_[源码和文档分享]基于JAVA的即时通信软件
一.设计任务书 1.1 设计任务本文设计的是一个简单的即时通信软件,利用 Java Socket 进行点到点通信,其工作机制模仿即时通信软件的基本功能,已实现的功能有:客户端登录客户端退出群组成 ...
飞机大战java代码_[源码和文档分享]Java飞机大战游戏设计与实现
1 概述 1.1 项目简介本次Java课程设计是做一个飞机大战的游戏,应用Swing编程,完成一个界面简洁流畅.游戏方式简单,玩起来易于上手的桌面游戏.该飞机大战项目运用的主要技术即是Swing编程 ...
idea模板注释快捷键_idea生成文档注释快捷键
技术文档主体内容:可以认为是页面最想表达的内容总和.对于内容详情页来说,主体内容指从标题开始至正文内容结束,翻页区域也被视为主体内容,文章后的评论.分享.推荐等不视为主体内容. 首屏:用户点击搜索结 ...

Java注释：单行、多行和文档注释

Java注释：单行、多行和文档注释相关推荐

最新文章

热门文章