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; // 初始化计数器
  • 连续多行需每行都加:// 第一行// 第二行,不能只写一个 // 跨多行

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

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

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

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

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

唱鸭
唱鸭

音乐创作全流程的AI自动作曲工具,集 AI 辅助作词、AI 自动作曲、编曲、混音于一体

下载

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

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

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

相关专题

更多
java
java

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

805

2023.06.15

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

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

724

2023.07.05

java自学难吗
java自学难吗

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

727

2023.07.31

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

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

395

2023.08.01

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

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

398

2023.08.02

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

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

445

2023.08.02

java有什么用
java有什么用

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

428

2023.08.02

java在线网站
java在线网站

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

16861

2023.08.03

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共23课时 | 2.1万人学习

C# 教程
C# 教程

共94课时 | 5.7万人学习

Java 教程
Java 教程

共578课时 | 39.9万人学习

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

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