关于Java代码中注释的使用

        作为一枚程序猿除了每日辛勤的敲代码,还要不停地提升技术水平,写代码这么枯燥无聊的工作我们是如何日复一日,年复一年的坚守岗位的呢?当然是因为我们短短几行代码就可以解决人类日常所需,各个领域各种需求,包罗万象,也正是因为融于各种业务当中,我们的代码才变得生动起来。那我们每天写那么多代码,那么多的业务逻辑,我们要怎么维护或是接手某一块儿的工作呢?这个时候我们一定意识到了注释的重要性了,接下来我就注释的使用做一些经验分享。

         为什么写注释?
  •  提高代码可读性;
  • 使程序条理清晰;
  • 方便后期代码维护;
  • 方便程序员间的交流沟通;
  • 生成帮助文档。

        注释有哪些类型?

  • 单行注释

       // 注释一行

  • 多行注释

      /* ...... */ 注释若干行

  • 文档注释

       /**……*/文档注释

        javadoc注释标签语法

标签作用域说明
@author标明开发该类模块的作者
@version标明该类模块的版本
@see类,属性,方法参考转向(相关主题)
@param方法对方法中某参数的说明
@return方法对方法返回值的说明
@exception方法方法抛出的异常类型
@throws方法方法抛出的异常类型说明
@deprecated方法说明不建议使用该方法

        来自阿里的注释规约



        注释的应用

        主要以IEDA为示例

  • 类头注释


  • 方法注释


  • javadoc帮助生成注释文档

首先,要编写一个类,在需要的位置添加注释
然后,找到相应的文件夹下运行命令行执行
     javadoc -encoding UTF-8 -d Javadoc API -author -version TestJavadoc.java
     javadoc为jdk提供的工具jar
     -encoding UTF-8避免编码格式出现冲突
     -d Javadoc API是指在当前命令文件夹下创建Javadoc API文件夹,并在该文件夹下生成文档
     -author 是指作者

     -version是版本


评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值