讲师中心 微信公众号
AI工具推荐 视频效率加速

在Java中注释有哪几种形式_Java代码注释规范解析

陌浩小哥_6773

陌浩小哥_6773

发布时间:2026-02-01 16:27:09

|

979人浏览过

|

来源于php中文网

原创

Java中只有//、/.../、/.../三种合法注释;单行注释//从符号至行末忽略,不跨行且不识别字符串内//;多行注释/.../不支持嵌套;Javadoc注释/.../需严格格式,影响文档生成但不进入class文件。

在java中注释有哪几种形式_java代码注释规范解析

Java 中只有三种合法的注释形式,其余所谓“注释”要么是语法错误,要么是被编译器忽略的无效写法。

单行注释用 //,从符号开始到行末全部忽略

这是最常用也最安全的注释方式,适合临时禁用代码、添加简短说明或调试标记:

  • // 后面必须紧跟一个空格(非强制但属通用规范),例如 // 初始化连接池 而不是 //初始化连接池
  • 不能跨行,遇到换行即终止;若在字符串内出现 //,不会被识别为注释(因为已处于字面量中)
  • 常见误用:把 // 写成 /// 或 ////——多出来的斜杠只是普通字符,无特殊含义

多行注释用 /* ... */,支持嵌套吗?不支持

该形式可用于跨行说明或临时屏蔽大段代码,但有明确限制:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
  • 不支持嵌套:写 /* outer /* inner */ outer end */ 会导致编译失败,JDK 会报错 unclosed comment
  • 可出现在代码任意位置(包括语句中间),例如 int x = 10 /* + 20 */; 是合法的,但可读性极差,不建议
  • 注意与文档注释混淆:虽然都用 /* 开头,但只有以 /** 开始的才是 Javadoc 注释

Javadoc 注释用 /** ... */,只对 public 成员有效?不一定

该注释会被 javadoc 工具提取生成 API 文档,但其生效范围比很多人想的更灵活:

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

  • 默认情况下,javadoc 只处理 public 和 protected 类型的类、方法、字段;但可通过 -package 或 -private 参数扩展可见性
  • 必须严格以 /** 开头、*/ 结尾,且中间每行首的 * 是约定俗成的排版习惯(非语法要求),但 IDE 通常依赖它做格式化
  • 常见坑:/* *(星号前有空格)或 /***(三个星号)都不是合法 Javadoc,工具会直接跳过
  • 支持标准标签如 @param、@return、@throws,但自定义标签需额外配置才能被识别

真正容易被忽略的是注释与编译过程的关系:所有注释在编译期被完全剥离,不会进入 .class 文件,也不会影响运行时性能。但 Javadoc 注释如果写得不规范,会导致生成文档缺失关键信息,而这种问题往往上线后才暴露——那时连源码都未必还在手边。

热门AI工具

更多
小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1878

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

3024

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6304

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

6289

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

7854

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

11994

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

6199

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

6907

2025.08.07

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn