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

相关推荐

  • composer require-dev和require有什么不同_Composer Require与Require-Dev区别解析

    require用于声明项目运行必需的依赖,如框架、数据库组件和第三方SDK,这些包会随项目部署到生产环境;2. require-dev用于声明仅在开发和测试阶段需要的工具,如PHPUnit、PHPStan、Faker等,不会默认部署到生产环境;3. 安装时composer install根据环境决定…

    2026年5月10日
    1000
  • 修复Django电商项目中AJAX过滤产品列表图片不显示问题

    在Django电商项目中,当使用AJAX动态加载过滤后的产品列表时,常遇到图片无法正常显示的问题。这通常是由于前端模板中图片加载方式(如data-setbg属性结合JavaScript库)与AJAX动态内容更新机制不兼容所致。解决方案是直接在AJAX返回的HTML中使用标准的标签来渲染图片,确保浏览…

    2026年5月10日
    000
  • Golang JSON序列化:控制敏感字段暴露的最佳实践

    本教程探讨golang中如何高效控制结构体字段在json序列化时的可见性。当需要将包含敏感信息的结构体数组转换为json响应时,通过利用`encoding/json`包提供的结构体标签,特别是`json:”-“`,可以轻松实现对特定字段的忽略,从而避免敏感数据泄露,确保api…

    2026年5月10日
    000
  • 利用海象运算符简化条件赋值:Python教程与最佳实践

    本文旨在探讨Python中海象运算符(:=)在条件赋值场景下的应用。通过对比传统if/else语句与海象运算符,以及条件表达式,分析海象运算符在简化代码、提高可读性方面的优势与局限性。并通过具体示例,展示如何在列表推导式等场景下合理使用海象运算符,同时强调其潜在的复杂性及替代方案,帮助开发者更好地掌…

    2026年5月10日
    100
  • Debian syslog性能优化技巧有哪些

    提升Debian系统syslog (通常基于rsyslog)性能,关键在于精简配置和高效处理日志。以下策略能有效优化日志管理,提升系统整体性能: 精简配置,高效加载: 在rsyslog配置文件中,仅加载必要的输入、输出和解析模块。 使用全局指令设置日志级别和格式,避免不必要的处理。 自定义模板: 创…

    2026年5月10日
    000
  • 比特币新手教程 比特币交易平台有哪些

    比特币是一种去中心化的数字货币,基于区块链技术实现点对点交易,具有匿名性、有限发行和不可篡改等特点;新手可通过交易所购买,P2P交易获得比特币,常用平台包括Binance、OKX和Huobi;交易流程包括注册账户、实名认证、绑定支付方式、充值法币并下单购买,可选择市价单或限价单;比特币存储方式有交易…

    2026年5月10日
    000
  • c++中的SFINAE技术是什么_c++模板编程中的SFINAE原理与应用

    SFINAE 是“替换失败不是错误”的原则,指模板实例化时若参数替换导致错误,只要存在其他合法候选,编译器不报错而是继续重载决议。它用于条件启用模板、类型检测等场景,如通过 decltype 或 enable_if 控制函数重载,实现类型特征判断。尽管 C++20 引入 Concepts 简化了部分…

    2026年5月10日
    000
  • Go语言mgo查询构建:深入理解bson.M与日期范围查询的正确实践

    本文旨在解决go语言mgo库中构建复杂查询时,特别是涉及嵌套`bson.m`和日期范围筛选的常见错误。我们将深入剖析`bson.m`的类型特性,解释为何直接索引`interface{}`会导致“invalid operation”错误,并提供一种推荐的、结构清晰的代码重构方案,以确保查询条件能够正确…

    2026年5月10日
    100
  • 修复点击时按钮抖动:CSS垂直对齐实践

    本文探讨了在Web开发中,交互式按钮(如播放/暂停按钮)在点击时发生意外垂直位移的问题。通过分析CSS样式变化对元素布局的影响,我们发现这是由于按钮不同状态下的边框样式和内边距改变,以及默认的垂直对齐行为共同作用所致。核心解决方案是利用CSS的vertical-align属性,将其设置为middle…

    2026年5月10日
    000
  • 理解编程指令:当结果正确,但实现方式不符要求时

    本文探讨了在编程实践中,即使程序输出了正确的结果,但若其实现方式未能严格遵循既定指令,仍可能被视为“不正确”的问题。我们将通过具体示例,对比直接求和与累加求和两种实现策略,强调理解和遵守编程规范的重要性,以确保代码的健壮性、可维护性及符合项目要求。 在软件开发过程中,我们经常会遇到这样的情况:编写的…

    2026年5月10日
    000
  • Golang goroutine与channel调试技巧

    使用go run -race检测数据竞争,结合runtime.NumGoroutine监控协程数量,通过pprof分析阻塞调用栈,利用select超时避免永久阻塞,有效排查goroutine泄漏、死锁和数据竞争问题。 Go语言的goroutine和channel是并发编程的核心,但它们也带来了调试上…

    2026年5月10日
    000
  • 《魔兽世界》将于6月11日开启国服回归技术测试

    《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试

    《%ign%ignore_a_1%re_a_1%》官方宣布,将于6月11日开启国服回归技术测试,时间为7天,并称可以在6月内正式开服,玩家们可以访问官网下载战网客户端并预下载“巫妖王之怒”客户端,技术测试详情见下图。 WordAi WordAI是一个AI驱动的内容重写平台 53 查看详情 以上就是《…

    2026年5月10日 用户投稿
    200
  • 使用 Jupyter Notebook 进行探索性数据分析

    Jupyter Notebook通过单元格实现代码与Markdown结合,支持数据导入(pandas)、清洗(fillna)、探索(matplotlib/seaborn可视化)、统计分析(describe/corr)和特征工程,便于记录与分享分析过程。 Jupyter Notebook 是进行探索性…

    2026年5月10日
    000
  • php常量怎么用_PHP常量(define/const)定义与使用方法

    PHP中可通过define函数和const关键字定义常量,用于存储不可变值。define适用于全局作用域,支持动态名称和条件定义,如define(‘SITE_NAME’, ‘MyWebsite’);const在编译时生效,语法简洁但限制多,只能在类或全…

    2026年5月10日
    000
  • 如何在HTML中插入表单元素_HTML表单控件与输入类型使用指南

    HTML表单通过标签构建,包含action和method属性定义数据提交目标与方式,常用input类型如text、password、email等适配不同输入需求,配合label、required、placeholder提升可用性,结合textarea、select、button等控件实现完整交互,是…

    2026年5月10日
    000
  • 前端缓存策略与JavaScript存储管理

    根据数据特性选择合适的存储方式并制定清晰的读写与清理逻辑,能显著提升前端性能;合理运用Cookie、localStorage、sessionStorage、IndexedDB及Cache API,结合缓存策略与定期清理机制,可在保证用户体验的同时避免安全与性能隐患。 前端缓存和JavaScript存…

    2026年5月10日
    100
  • 网站标题关键词更新后,搜索引擎为何仍显示旧标题?

    网站标题更新后,搜索引擎为何显示旧标题? 网站SEO优化中,站长常修改网站标题关键词,期望搜索结果显示自定义标题。然而,即使更新标签、meta keywords、meta description和结构化数据中的name属性后,搜索结果仍显示旧标题,这令人费解。本文将对此进行解释。 问题:站长修改了网…

    2026年5月10日
    100
  • HTML5网页如何实现手势操作 HTML5网页移动端交互的处理技巧

    首先利用原生touch事件实现滑动判断,再通过preventDefault解决滚动冲突,接着引入Hammer.js处理复杂手势,最后通过优化点击区域、避免事件冲突和增加视觉反馈提升体验。 在移动端浏览器中,HTML5网页可以通过触摸事件实现手势操作,提升用户体验。虽然原生JavaScript提供了基…

    2026年5月10日
    000
  • 创建指定大小并填充特定数据的Golang文件教程

    本文将介绍如何使用Golang创建一个指定大小的文件,并用特定数据填充它。我们将使用 `os` 包提供的函数来创建和截断文件,从而实现快速生成大文件的目的。示例代码展示了如何创建一个10MB的文件,并将其填充为全零数据。掌握这些方法,可以方便地在例如日志系统或磁盘队列等场景中,预先创建测试文件或初始…

    2026年5月10日
    000
  • Python命令怎样使用profile分析脚本性能 Python命令性能分析的基础教程

    使用Python的cProfile模块分析脚本性能最直接的方式是通过命令行执行python -m cProfile your_script.py,它会输出每个函数的调用次数、总耗时、累积耗时等关键指标,帮助定位性能瓶颈;为进一步分析,可将结果保存为文件python -m cProfile -o ou…

    2026年5月10日
    000

发表回复

登录后才能评论
关注微信