0

0

Java里注释有哪几种写法_Java代码注释规范说明

P粉602998670

P粉602998670

发布时间:2025-12-31 19:00:09

|

537人浏览过

|

来源于php中文网

原创

Java注释只有三种合法形式:单行注释//、多行注释/.../、文档注释/.../;//从本行起至末尾被忽略,不可在字符串内使用;/.../不支持嵌套,首个/即终止;/...*/须严格配对且紧贴程序元素,供javadoc解析。

java里注释有哪几种写法_java代码注释规范说明

Java 里注释只有三种合法写法,其他所谓“注释”要么是语法错误,要么是编译器忽略的垃圾字符。

单行注释用 //

// 开始到本行末尾全部被忽略,支持出现在行首、代码后、空格后,但不能在字符串或字符字面量中使用(否则会破坏字符串结构)。

  • 常见误用:String s = "hello // world"; —— 这里的 // 是字符串内容,不是注释
  • 可嵌套在语句后:int x = 1; // 初始化计数器
  • 连续多行需每行都加:// 第一行// 第二行,不能只写一个 // 跨多行

多行注释用 /* ... */

匹配成对的 /**/,中间所有内容(包括换行、空格、代码)全被跳过。不支持嵌套 —— 第一个 */ 就结束注释,后续哪怕还有 /* 也会被当普通文本处理。

飞书多维表格
飞书多维表格

表格形态的AI工作流搭建工具,支持批量化的AI创作与分析任务,接入DeepSeek R1满血版

下载
  • 典型翻车现场:
    /*
     * int i = 0;
     /* 嵌套注释?错 */
     * i++;
     */
    —— 实际在第一个 */ 处就结束了,后面 * i++; 会报编译错误
  • 适合临时屏蔽大段代码,但别用来写文档(IDE 不识别,javadoc 工具也不解析)
  • 行内也可用:int /* 被注释掉的 */ y = 2;,但可读性差,不推荐

文档注释用 /** ... */

仅当以 /** 开头、以 */ 结尾,且中间每行可选以 * 开头(用于对齐),才被 javadoc 工具识别为文档注释。它必须紧贴在类、方法、字段等程序元素之前,中间不能有空行。

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

  • 必须严格配对:/** 不能写成 /* */***,否则只是普通多行注释
  • 常见参数标记如 @param@return@throws 必须独占一行且顶格或缩进一致,否则 javadoc 不解析
  • 示例:
    /**
     * 计算两个整数之和
     * @param a 加数
     * @param b 被加数
     * @return 和
     */
    public int add(int a, int b) {
        return a + b;
    }

真正容易被忽略的是:注释不会影响字节码大小,但写在 private 方法里的文档注释,如果没运行 javadoc,就纯粹是给阅读者看的 —— IDE 可能显示,但 JVM 一概不管。别指望它能替代单元测试或类型检查。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1030

2023.08.02

js 字符串转数组
js 字符串转数组

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

760

2023.08.03

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

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

221

2023.09.04

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

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

1566

2023.10.24

字符串介绍
字符串介绍

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

649

2023.11.24

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

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

1228

2024.03.22

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

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

1204

2024.04.29

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

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

192

2025.07.29

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共23课时 | 4.3万人学习

C# 教程
C# 教程

共94课时 | 11.2万人学习

Java 教程
Java 教程

共578课时 | 81万人学习

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

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