0

0

java怎样用/**/添加多行注释 java多行注释语句的基础教程

看不見的法師

看不見的法師

发布时间:2025-08-08 16:31:01

|

772人浏览过

|

来源于php中文网

原创

java中写多行注释最直接的方式是使用/和/,1. 它能包裹多行文字或代码,使编译器忽略其内容;2. 与单行注释//相比,/ /更适合解释复杂逻辑或整体设计思路,支持跨行叙述,便于临时禁用代码块;3. 实际开发中常用于说明非自解释代码、临时注释代码区域,但需避免过度注释、保持注释同步更新,并注意/ /不支持嵌套;4. 除多行注释外,java还提供单行注释//用于简短说明,以及javadoc注释/ /用于生成api文档,后者通过@param、@return等标签自动生成html文档,提升代码可维护性;综上,合理使用//、/ /和/ /三种注释方式是编写高质量java代码的关键。

java怎样用/**/添加多行注释 java多行注释语句的基础教程

Java里,如果你想写一段跨越多行的注释,最直接的方式就是使用

/*
*/
这对符号。它能让你把一大段说明文字或者暂时不需要运行的代码包裹起来,让编译器直接忽略掉,非常方便。

要使用

/* */
添加多行注释,你只需要在注释内容的起始位置放一个
/*
,然后在注释内容的结束位置放一个
*/
就行了。这两者之间的所有内容,无论是多少行,都会被Java编译器视为注释,不参与程序的编译和执行。

举个例子,就像这样:

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

public class CommentExample {
    public static void main(String[] args) {
        /*
         * 这是一个多行注释的例子。
         * 我可以在这里写很多行文字,
         * 解释我的代码逻辑,
         * 甚至暂时禁用一大段代码。
         */
        System.out.println("Hello, World!"); // 这是一行普通代码

        /*
        int a = 10;
        int b = 20;
        System.out.println(a + b);
        */ // 这段代码被注释掉了,不会执行
    }
}

你看,它非常直观,就像给一段文字加了个边框,告诉编译器:“嘿,这块内容你别管,这是给人看的。”

为什么我们需要多行注释,它和单行注释有什么区别

这个问题,在我看来,其实挺核心的。我们写代码,不光是为了让机器跑起来,更重要的是让人能看懂,尤其是未来维护你代码的人,或者几个月后回过头来看自己代码的你。单行注释

//
当然好用,它适合快速标注一行代码的意图,或者某个变量的含义。但当你需要解释一个复杂的算法流程,或者一段功能模块的整体思路时,一行行的
//
就会显得非常零碎,甚至有些碍眼。

这时候,

/* */
的优势就体现出来了。它提供了一个“区域”,你可以自由地在里面组织你的文字,写出完整的句子、段落,甚至画个简单的ASCII图。我个人觉得,它更像是一种“叙述性”的注释,用来描述“为什么”这样做,或者“这段代码的整体目的是什么”。而
//
更多是“是什么”和“怎么做”的局部说明。

另一个大区别在于,

/* */
可以很方便地用来“禁用”一大块代码。比如你在调试的时候,想暂时跳过某段逻辑,或者测试不同实现方式,直接把那段代码用
/* */
包起来就行,比一行行删掉或者改用
//
要高效得多。这在排查问题时,简直是神器。

在实际开发中,多行注释有哪些常见的使用场景和注意事项?

实际开发里,多行注释的用处可多了。最常见的,当然是用来解释那些非自解释的代码块。比如,你实现了一个比较巧妙的位运算,或者一个涉及多线程同步的复杂逻辑,这时候不加个

/* */
详细说明,后面的人估计得抓耳挠腮。我遇到过不少代码,光看变量名和函数名根本猜不透其深意,这时候如果能有几段清晰的多行注释,那简直是救命稻草。

还有一种非常实用的场景,就是我前面提到的,临时注释掉一大段代码。这在重构、测试或者功能切换时特别有用。你可能在尝试两种不同的实现方案,或者需要回溯到某个旧版本的功能,直接用

/* */
圈起来,代码还在那里,但不会执行,方便你随时切换回来。

MiniMax Agent
MiniMax Agent

MiniMax平台推出的Agent智能体助手

下载

不过,用多行注释也有几点需要注意的。

别过度注释。有些代码本身就非常清晰,比如

int sum = a + b; // 计算a和b的和
,这种注释就显得多余了,反而会增加阅读负担。注释的目的是为了弥补代码在表达力上的不足,而不是重复代码本身。

注释内容要保持更新。这是个老大难问题。代码改了,注释没跟着改,那这注释就成了误导。我宁愿看到没注释的代码,也不想看到错误的注释。所以,每次修改代码,都要习惯性地检查一下相关的注释是否还需要调整。

再来,

/* */
注释是不能嵌套的。也就是说,你不能在一个
/* ... */
里面再写一个
/* ... */
。这会导致编译错误。如果你需要注释掉一段已经包含
/* */
注释的代码,通常的做法是使用IDE的“块注释”功能,或者直接使用单行注释
//
来覆盖整个区域。

除了基础的多行注释,Java还有哪些相关的注释方式?

Java在注释这块,其实挺周到的,除了咱们一直在说的

/* */
,它还有另外两种非常重要的注释方式,各自有其独特的用途。

最常见也是最基础的,就是单行注释

//
。这个大家应该都熟,从
//
开始到行尾,所有内容都是注释。它非常适合快速地给某一行代码做个简短的说明,或者暂时禁用一行代码。我平时写代码,用
//
的频率可能比
/* */
还要高,因为它轻量、灵活,适合即时性的标注。

而另一个重量级的选手,就是文档注释,也就是 Javadoc 注释 `/ */

**。这个跟
/ /
长得有点像,就多了一个星号。但它可不仅仅是多了一个星号那么简单,它的作用是用来生成API文档的。当你用
javadoc` 工具处理包含这种注释的源代码时,它能自动生成HTML格式的文档,清晰地展示你的类、方法、字段的功能、参数、返回值等等。

一个典型的Javadoc注释看起来是这样的:

/**
 * 这个方法用于计算两个整数的和。
 * 它会检查输入是否为负数,如果是,则抛出异常。
 *
 * @param a 第一个整数
 * @param b 第二个整数
 * @return 两个整数的和
 * @throws IllegalArgumentException 如果a或b为负数
 */
public int add(int a, int b) {
    if (a < 0 || b < 0) {
        throw new IllegalArgumentException("输入不能为负数");
    }
    return a + b;
}

你看,它里面可以包含

@param
@return
@throws
这样的特殊标签,这些标签在生成文档时会被解析成特定的格式。在我看来,Javadoc注释是专业Java项目不可或缺的一部分,它极大地提升了代码的可读性和可维护性,尤其是对于那些需要被其他开发者使用的公共API。

所以,总结一下,Java提供了

//
/* */
/** */
三种注释方式,它们各司其职,覆盖了从代码内部说明到外部API文档生成的所有需求。理解并合理运用它们,是写出高质量Java代码的关键一环。

相关专题

更多
java
java

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

832

2023.06.15

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

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

737

2023.07.05

java自学难吗
java自学难吗

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

734

2023.07.31

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

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

397

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基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16925

2023.08.03

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

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

共23课时 | 2.5万人学习

C# 教程
C# 教程

共94课时 | 6.7万人学习

Java 教程
Java 教程

共578课时 | 45.9万人学习

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

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