JAVA的三种注释方法

Java的三种注释形式包括单行注释、多行注释和文档注释。

单行注释:

//

可以用于对单行代码的简单解释,也可以用于快速注释掉某行代码,十分简洁明了。

多行注释

/* … */

用于较长的注释,通常用于解释代码块,代码的逻辑功能,或者代码的变更,或者用于吐槽,或者用于上一代、这一代、和下一代维护工程师之间的沟通与交流。

需要注意的是使用多行注释时要避免在多行注释内部嵌套多行注释,不然很容易出现bug。

文档注释

/**… */

提供非常详细的API说明,通常用于大项目开发中的功能解释。

文档注释中包含`@param`、`@return`、`@throws`等标签来详细说明方法参数、返回值和可能抛出的各类程序异常。

注意:

单行注释和多行注释在编译时不参与程序执行。

文档注释在编译时则会被Javadoc工具提取出来,生成可用于API文档的文本。

原创文章,作者:guozi,如若转载,请注明出处:https://www.sudun.com/ask/81031.html

(0)
guozi's avatarguozi
上一篇 2024年5月31日 上午11:19
下一篇 2024年5月31日 上午11:20

相关推荐

  • 脉宽调制pwm控制器原理,什么是脉宽调制技术

    脉宽调制,顾名思义,可通过对脉冲宽度的调整来完成某种功能的技术,那么其究竟是如何来完成对脉冲宽度的调整?其又可实现什么功能呢?赶紧跟随小编来了解一下脉宽调制原理

    行业资讯 2024年6月1日
    0
  • 宁波高防云服务器

    宁波高防云服务器,你是否曾听说过这样一个名词?它究竟是什么,又有着怎样的技术特点?在宁波地区,又有哪些提供商能够为我们提供这样的服务?而对于普通用户来说,高防云服务器的价格标准又是…

    行业资讯 2024年4月15日
    0
  • 如何选择适合自己的dbs主机?

    云服务器行业近年来发展迅速,越来越多的人开始选择使用dbs主机来搭建自己的网站或应用。但是对于初学者来说,如何选择适合自己的dbs主机可能是一个比较棘手的问题。今天,我们将为大家介…

    行业资讯 2024年3月24日
    0
  • 南昌建厂,南昌建站方案

    您想在南昌建立自己的网站吗?不知道如何选择合适的网站建设公司?或者还不确定要准备哪些资料?担心?请不要。本文详细介绍了南昌网站建设行业的概况和发展趋势。让我们一起探索这个快速发展的…

    行业资讯 2024年4月13日
    0

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注