0

0

在Java中注释如何书写_Java单行与多行注释说明

P粉602998670

P粉602998670

发布时间:2026-01-21 15:49:31

|

717人浏览过

|

来源于php中文网

原创

Java注释分//、/.../和/.../三类://用于单行,不跨行且不可在字符串内;/.../支持多行但禁止嵌套;/.../为Javadoc注释,需紧邻声明且含标准标签。

在java中注释如何书写_java单行与多行注释说明

Java 中注释不是可有可无的装饰,而是影响代码可维护性、IDE 行为甚至编译结果的关键部分——比如 @Deprecated 的生效依赖 Javadoc 注释结构,而误用多行注释嵌套会导致编译失败。

单行注释用 //,但别在字符串或字符字面量里乱加

// 从出现位置开始到行尾全部忽略,不跨行。它安全、轻量,适合临时禁用代码或写简短说明。

  • ✅ 正确:在逻辑行首或语句后添加,如 int x = 1; // 初始化计数器
  • ❌ 错误:写在字符串内部,如 String s = "hello // world"; —— 这里的 // 是字符串内容,不会被当注释,也不会截断字符串
  • ⚠️ 注意:// 不会跳过换行符,所以不能用来“注释掉”含换行的多行表达式(比如拆成多行的 long 方法调用),必须每行都加

多行注释用 /* ... */,但严禁嵌套

/* 到下一个 */ 之间的所有内容(含换行)都被忽略。它适合临时屏蔽大段代码,也用于写较详细的说明。

  • ✅ 正确:/* 这是合法的多行注释,可以跨行 */
  • ❌ 致命错误:/* 外层注释 /* 内层注释 */ 继续外层 */ —— Java 不支持嵌套,第一个 */ 就结束整个注释,后续文本可能引发编译错误
  • ⚠️ 注意:如果用它注释掉一段含 /**/ 的代码(比如正则表达式或 SQL 字符串),容易意外提前终止注释,建议改用连续 //

Javadoc 注释是 /** ... */,不是普通多行注释

只有以 /** 开头、*/ 结尾的块,且紧邻类/方法/字段声明上方,才会被 javadoc 工具识别为文档注释。它有固定标签语法,比如 @param@return

酷兔AI论文
酷兔AI论文

专业原创高质量、低查重,免费论文大纲,在线AI生成原创论文,AI辅助生成论文的神器!

下载

立即学习Java免费学习笔记(深入)”;

  • ✅ 正确:
    /**
     * 计算两个整数之和
     * @param a 加数
     * @param b 被加数
     * @return 和
     */
    public int add(int a, int b) { return a + b; }
  • ❌ 无效:/* 这只是普通多行注释,javadoc 工具完全忽略 */
  • ⚠️ 注意:Javadoc 注释中若漏写 @param 标签,某些 IDE 会警告;但更隐蔽的问题是,如果在方法体内部写了 /** ... */,它虽不报错,却不会生成文档,还可能误导他人

真正容易被忽略的是注释与代码边界的模糊性——比如在 if 条件后直接跟 //,看似注释,实则可能掩盖逻辑歧义;又比如用 /* 注释掉半行语句,导致语法残缺。注释不是“写给人看的”,而是“写给此刻和三个月后的自己看的”,它的存在本身就应该经得起重读和重构。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

841

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

742

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

739

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

399

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7.2万人学习

Java 教程
Java 教程

共578课时 | 48.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号