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

Rose.ai
Rose.ai

一个云数据平台,帮助用户发现、可视化数据

下载

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

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1134

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

381

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2174

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

380

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1703

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

586

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

440

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

25

2026.03.13

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.3万人学习

Java 教程
Java 教程

共578课时 | 81.6万人学习

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

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