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:13
下一篇 2025年11月5日 16:42:09

相关推荐

  • CSS mask属性无法获取图片:为什么我的图片不见了?

    CSS mask属性无法获取图片 在使用CSS mask属性时,可能会遇到无法获取指定照片的情况。这个问题通常表现为: 网络面板中没有请求图片:尽管CSS代码中指定了图片地址,但网络面板中却找不到图片的请求记录。 问题原因: 此问题的可能原因是浏览器的兼容性问题。某些较旧版本的浏览器可能不支持CSS…

    2025年12月24日
    900
  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 为什么设置 `overflow: hidden` 会导致 `inline-block` 元素错位?

    overflow 导致 inline-block 元素错位解析 当多个 inline-block 元素并列排列时,可能会出现错位显示的问题。这通常是由于其中一个元素设置了 overflow 属性引起的。 问题现象 在不设置 overflow 属性时,元素按预期显示在同一水平线上: 不设置 overf…

    2025年12月24日 好文分享
    400
  • 网页使用本地字体:为什么 CSS 代码中明明指定了“荆南麦圆体”,页面却仍然显示“微软雅黑”?

    网页中使用本地字体 本文将解答如何将本地安装字体应用到网页中,避免使用 src 属性直接引入字体文件。 问题: 想要在网页上使用已安装的“荆南麦圆体”字体,但 css 代码中将其置于第一位的“font-family”属性,页面仍显示“微软雅黑”字体。 立即学习“前端免费学习笔记(深入)”; 答案: …

    2025年12月24日
    000
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么我的特定 DIV 在 Edge 浏览器中无法显示?

    特定 DIV 无法显示:用户代理样式表的困扰 当你在 Edge 浏览器中打开项目中的某个 div 时,却发现它无法正常显示,仔细检查样式后,发现是由用户代理样式表中的 display none 引起的。但你疑问的是,为什么会出现这样的样式表,而且只针对特定的 div? 背后的原因 用户代理样式表是由…

    2025年12月24日
    200
  • inline-block元素错位了,是为什么?

    inline-block元素错位背后的原因 inline-block元素是一种特殊类型的块级元素,它可以与其他元素行内排列。但是,在某些情况下,inline-block元素可能会出现错位显示的问题。 错位的原因 当inline-block元素设置了overflow:hidden属性时,它会影响元素的…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 为什么使用 inline-block 元素时会错位?

    inline-block 元素错位成因剖析 在使用 inline-block 元素时,可能会遇到它们错位显示的问题。如代码 demo 所示,当设置了 overflow 属性时,a 标签就会错位下沉,而未设置时却不会。 问题根源: overflow:hidden 属性影响了 inline-block …

    2025年12月24日
    000
  • 如何利用 CSS 选中激活标签并影响相邻元素的样式?

    如何利用 css 选中激活标签并影响相邻元素? 为了实现激活标签影响相邻元素的样式需求,可以通过 :has 选择器来实现。以下是如何具体操作: 对于激活标签相邻后的元素,可以在 css 中使用以下代码进行设置: li:has(+li.active) { border-radius: 0 0 10px…

    2025年12月24日
    100
  • 为什么我的 CSS 元素放大效果无法正常生效?

    css 设置元素放大效果的疑问解答 原提问者在尝试给元素添加 10em 字体大小和过渡效果后,未能在进入页面时看到放大效果。探究发现,原提问者将 CSS 代码直接写在页面中,导致放大效果无法触发。 解决办法如下: 将 CSS 样式写在一个单独的文件中,并使用 标签引入该样式文件。这个操作与原提问者观…

    2025年12月24日
    000
  • 如何模拟Windows 10 设置界面中的鼠标悬浮放大效果?

    win10设置界面的鼠标移动显示周边的样式(探照灯效果)的实现方式 在windows设置界面的鼠标悬浮效果中,光标周围会显示一个放大区域。在前端开发中,可以通过多种方式实现类似的效果。 使用css 使用css的transform和box-shadow属性。通过将transform: scale(1.…

    2025年12月24日
    200
  • 为什么我的 em 和 transition 设置后元素没有放大?

    元素设置 em 和 transition 后不放大 一个 youtube 视频中展示了设置 em 和 transition 的元素在页面加载后会放大,但同样的代码在提问者电脑上没有达到预期效果。 可能原因: 问题在于 css 代码的位置。在视频中,css 被放置在单独的文件中并通过 link 标签引…

    2025年12月24日
    100
  • 为什么我的 Safari 自定义样式表在百度页面上失效了?

    为什么在 Safari 中自定义样式表未能正常工作? 在 Safari 的偏好设置中设置自定义样式表后,您对其进行测试却发现效果不同。在您自己的网页中,样式有效,而在百度页面中却失效。 造成这种情况的原因是,第一个访问的项目使用了文件协议,可以访问本地目录中的图片文件。而第二个访问的百度使用了 ht…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信