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

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图。我个人觉得,它更像是一种“叙述性”的注释,用来描述“为什么”这样做,或者“这段代码的整体目的是什么”。而

//

更多是“是什么”和“怎么做”的局部说明。

另一个大区别在于,

/* */

可以很方便地用来“禁用”一大块代码。比如你在调试的时候,想暂时跳过某段逻辑,或者测试不同实现方式,直接把那段代码用

/* */

包起来就行,比一行行删掉或者改用

//

要高效得多。这在排查问题时,简直是神器。

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

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

/* */

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

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

/* */

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

行者AI 行者AI

行者AI绘图创作,唤醒新的灵感,创造更多可能

行者AI 100 查看详情 行者AI

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

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

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多行注释语句的基础教程的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/337112.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
小红书收藏内容不见了怎么办 小红书收藏恢复与管理技巧
上一篇 2025年11月5日 16:41:21
ATX 3.0 电源标准解析:应对高端显卡瞬时功耗测试
下一篇 2025年11月5日 16:41:35

相关推荐

  • python 基准测试(cProfile kcachegrind line_profiler memory_profiler)

    learn from 《python高性能(第2版)》 类似工具:pycharm profile对函数调用效率进行测试 1. 例子 一个圆周运动的动画 代码语言:javascript代码运行次数:0运行复制 from matplotlib import pyplot as pltfrom matpl…

    2026年9月22日
    100
  • NvidiaCanvas的AI混合工具如何使用?创作智能画作的详细教程

    NVIDIA Canvas是一款基于AI的智能图像生成器,它将用户涂鸦的材质色块实时转化为逼真风景,核心在于语义理解与风格化合成。其工作流程包括选择材质笔刷、在输入画布绘制概念图、利用图层与风格预设快速迭代,并导出成果。相比传统绘画工具,Canvas优势在于高效生成、降低创作门槛、支持快速探索与创意…

    2026年9月22日
    200
  • VSCode安装C/C++开发环境 最新VSCode配置C语言教程详解

    答案:搭建VSCode的C/C++环境需安装编译器、C/C++扩展并配置项目文件。首先安装MinGW(Windows)、Clang(macOS)或GCC(Linux),配置环境变量并验证;然后在VSCode中安装Microsoft的C/C++扩展;最后创建.c_cpp_properties.json…

    2026年9月22日
    200
  • diskgenius如何设置Bios启动项

    diskgenius是一款功能全面的磁盘管理软件,在实际操作中,为了顺利运行该工具或进行系统维护,常常需要在bios中调整启动顺序。以下是详细的设置步骤说明。 当计算机开机或重启时,请留意屏幕初始画面中的提示信息,按下指定键进入bios设置界面。不同品牌和型号的主板所使用的快捷键有所区别,常见的包括…

    2026年9月22日
    100
  • MySQL如何设计数据库备份恢复的自动化流程_工具推荐?

    MySQL如何设计数据库备份恢复的自动化流程_工具推荐?MySQL如何设计数据库备份恢复的自动化流程_工具推荐?MySQL如何设计数据库备份恢复的自动化流程_工具推荐?MySQL如何设计数据库备份恢复的自动化流程_工具推荐?

    mysql数据库的备份与恢复自动化流程应从备份类型、工具选择、配置步骤及注意事项四方面入手。1. 明确备份类型与频率:根据rpo要求选择完整+增量备份组合,设定每日/每周任务。2. 推荐使用automysqlbackup(适合中小型系统)、mydumper/myloader(高效逻辑备份)、zrm …

    2026年9月22日 用户投稿
    300
  • 抖音卖货怎么挂小黄车?怎么看自己小黄车挂的货呢

    随着短视频平台的迅速发展,抖音成为了越来越多商家和个体创业者展示商品的重要渠道。其中,小黄车作为抖音电商体系中的核心工具之一,能够帮助用户在视频中直接引导消费者完成购买操作。那么,如何在抖音上成功挂出小黄车?又该如何查看自己已上传的商品呢?接下来我们将为您详细解析。 一、小黄车的功能与特点 小黄车是…

    2026年9月22日
    000
  • 360浏览器怎么禁止网页自动刷新_360浏览器阻止页面定时刷新设置方法

    1、通过360浏览器开发者工具删除含http-equiv=”refresh”的meta标签可临时阻止刷新;2、启用弹窗拦截功能可屏蔽由脚本触发的自动刷新;3、使用无痕模式浏览可限制脚本运行,避免页面刷新;4、安装“Tampermonkey”等扩展并添加屏蔽规则可实现长期有效阻…

    2026年9月22日
    200
  • 在Java中如何通过Stream实现交集与差集

    交集可通过filter结合contains获取两集合共有元素,差集则保留一个集合中不在另一集合的元素,示例使用list1.stream().filter(list2::contains)得[3,4],filter(e->!list2.contains(e))得[1,2],建议将list2转为H…

    2026年9月22日
    000
  • Java Swing中按钮与文本框事件处理的实践指南

    本文将深入探讨Java Swing中ActionListener的正确使用方法,指导开发者如何为GUI按钮和文本框实现事件监听,从而处理用户输入、执行计算并实时更新界面。文章将重点讲解如何在actionPerformed方法中获取用户输入、进行类型转换、处理潜在异常,并提供一个完整的计算器示例来演示…

    2026年9月22日
    100
  • MySQL查询缓存配置及性能_MySQL重复查询响应速度提升

    MySQL查询缓存配置及性能_MySQL重复查询响应速度提升MySQL查询缓存配置及性能_MySQL重复查询响应速度提升MySQL查询缓存配置及性能_MySQL重复查询响应速度提升MySQL查询缓存配置及性能_MySQL重复查询响应速度提升

    mysql查询缓存已不适用于现代应用场景,尤其在8.0版本中被彻底移除。它仅适合读多写少、数据几乎不变的静态查询,通过内存直接返回结果提升性能;但在数据频繁更新时,因基于表级的缓存失效机制,每次写操作都会清空相关缓存,导致频繁重建缓存并消耗大量cpu资源,形成性能瓶颈。此外,sql语句匹配严格、内存…

    2026年9月22日 用户投稿
    400
  • VSCode搭建前端开发环境(新手必备,插件配置详解)

    vscode是前端开发的理想选择,因其轻量、可扩展且拥有活跃的社区支持,能通过插件将基础编辑器打造成高效智能的开发环境。其优势在于启动快、资源占用低、内置git和调试工具,并拥有强大的插件生态,适配react、vue等各类前端技术栈。新手必装插件包括eslint与prettier(保障代码规范与格式…

    2026年9月22日
    000
  • Linux平台下的Eclipse配置

    在linux平台上配置eclipse时,可能会遇到一些常见的问题和优化需求。本文将详细介绍如何解决这些问题,并提供优化eclipse的建议。 启动Eclipse报错 启动Eclipse时,如果遇到以下错误: A Java Runtime Environment (JRE) or Java Devel…

    2026年9月22日
    000
  • 怎样在iPhone情侣模式中分享视频?快速上传和同步的实用方法

    怎样在iPhone情侣模式中分享视频?快速上传和同步的实用方法怎样在iPhone情侣模式中分享视频?快速上传和同步的实用方法怎样在iPhone情侣模式中分享视频?快速上传和同步的实用方法怎样在iPhone情侣模式中分享视频?快速上传和同步的实用方法

    最实用的方法是使用iCloud共享相簿,它支持情侣间视频快速上传与实时同步。首先双方需开启iCloud照片中的共享相簿功能,然后创建专属相簿并邀请对方加入。此后,任一方添加的视频会自动同步至对方设备,且不占用个人iCloud空间。相比AirDrop(限近距离)、即时通讯工具(压缩画质)或云盘(占存储…

    2026年9月22日 用户投稿
    000
  • 想靠抖音带货赚钱?教你一键挂小黄车教程

    想靠抖音带货赚钱?教你一键挂小黄车教程想靠抖音带货赚钱?教你一键挂小黄车教程想靠抖音带货赚钱?教你一键挂小黄车教程想靠抖音带货赚钱?教你一键挂小黄车教程

    想靠抖音带货赚钱并不复杂,关键在于掌握正确方法。一、开通商品橱窗权限:需实名认证并发布原创视频,确保账号无违规记录;二、视频挂载小黄车:发布视频时点击“添加商品”按钮,选择商品并设置展示位置与时间;三、选品提升转化率:贴合视频内容、关注价格销量、参考热榜商品并测试不同组合;四、直播挂小黄车:互动性强…

    2026年9月22日 用户投稿
    100
  • 如何判断网络延迟(Ping值)过高是由运营商问题还是自身设备引起的?

    先重启设备并检查本地连接,若有线网络延迟降低则问题在无线信号;通过ping网关和外部DNS判断故障范围,结合tracert追踪路径,前几跳异常指向运营商问题,最后用官方测速工具验证并联系客服解决。 判断网络延迟高是运营商还是自身设备的问题,关键在于逐步隔离排查。从最接近你的设备开始测试,向外层层推进…

    2026年9月22日
    100
  • VSCode如何实现代码混淆 VSCode保护源代码的加密方案

    代码混淆无法通过vscode直接实现,需借助外部工具或构建流程。1. 使用构建工具如webpack或rollup配合terser等混淆器,在打包时自动混淆代码,通过vscode配置tasks.json运行构建任务。2. 可选vscode插件辅助,但应评估其安全性、混淆强度、性能影响、配置灵活性及社区…

    2026年9月22日
    100
  • 运营蝴蝶号必懂的五大策略,帮你迅速提升粉丝活跃度

    运营蝴蝶号必懂的五大策略,帮你迅速提升粉丝活跃度运营蝴蝶号必懂的五大策略,帮你迅速提升粉丝活跃度运营蝴蝶号必懂的五大策略,帮你迅速提升粉丝活跃度运营蝴蝶号必懂的五大策略,帮你迅速提升粉丝活跃度

    要真正提升“蝴蝶号”粉丝活跃度,核心在于建立深层次连接与持续价值输出。1.内容需有“钩子”,引发粉丝思考和表达欲;2.互动要升级为共创场景,如提问、投票、征集等方式增强参与感;3.构建专属社群(如微信群、discord)强化归属感;4.利用数据分析找准内容方向与粉丝活跃时段;5.跳出单平台思维,进行…

    2026年9月22日 用户投稿
    100
  • AdobeIllustrator如何导出AI生成的图片?矢量图像保存的步骤

    首先明确输出需求,再选择“文件>导出>导出为…”或“文件>存储为…”,根据用途选取合适格式如SVG、PDF或AI,确保矢量信息保留,参数设置需匹配目标平台要求。 ☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 免费无限量使用 DeepSeek R1 模型☜☜☜ Adob…

    2026年9月22日
    000
  • PHP面向对象开发:解决父类构造器参数在嵌套子对象方法中丢失的问题

    在PHP面向对象编程中,我们经常会遇到类继承和对象组合的场景。一个常见的问题是,当父类构造函数接收参数并用于初始化内部的子对象时,该子对象的方法在后续调用中可能无法正确访问到这些参数,甚至显示为null。本文将深入探讨这一问题,并提供两种有效的解决方案。 引言与问题阐述 考虑一个典型的web应用架构…

    2026年9月22日
    000
  • 使用MockWebServer对FeignClient进行单元测试

    本文详细阐述了如何利用Spring Cloud LoadBalancer和MockWebServer对FeignClient进行高效单元测试。通过在测试配置中动态注册MockWebServer实例,并将其作为FeignClient的服务发现目标,开发者可以精确模拟后端API的行为,包括各种HTTP响…

    2026年9月22日
    000

发表回复

登录后才能评论
关注微信