第十四章:Java编程之注释

编程中的注释对于代码的可读性和维护至关重要。它们解释了复杂的逻辑,帮助开发者理解当初的设计思路。博客介绍了Java的三种注释类型:单行、多行和文档注释,并强调了注释在团队合作和未来代码审查中的重要性。良好的注释习惯可以提高代码质量,降低后期维护难度。
摘要由CSDN通过智能技术生成

为什么要写注释

     在我们编程写代码的时候,除了写代码,有时还需要写注释。代码是写给机器看的,也是写给人看的,但是有的时候,代码写的不是很明白,一般人会看不懂,不知道这个是啥意思,为什么要这么做。 这个时候,就需要写注释,告诉后面看代码的人,这里为什么要这么写,不这样写行不行。

       一般的代码文件里,都会有很多注释,一般公司对这方面也会有要求,注释率必须达到20%或者更高。一般人写完代码,等别人来看的时候,很多时候都看不懂,有时甚至,几天之后,自己都看不懂当时为什么这么做了,所以注释就非常重要了。

Java注释

总共分为三类:

  1. 单行注释
  2. 多行注释
  3. 文档注释

单行注释

   采用//开头,如:

   //下面这个方法用来实现人工智能***,不要随便修改。

多行注释

   采用/*开头,*/结束,如:

   /*

我也不想写这么复杂的方法,但是产品经理要求这样做。

真的是没办法,程序员真的是太难了。

   */

文档注释

    采用/**开头,*/结束,如:

   /**

    * 我最喜欢的妹子昨天结婚了,我很伤感。

    * 为了冲淡一下感觉,我决定先写一天的代码,看看会不会好一些。

    * @author 十代码农

    */

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值