• 得体的注释,让我总能想起TA


    作为一个技术TL,在排查生产问题时,我经常要周转于各个工程里。系统和服务多起来后,要我了解每一段代码具体的来龙去脉逐渐几乎不可能了。

    例如,今天,我要查一下调用某个三方接口所配置的编码值。就按自己的印象扒代码。我下意识里感觉到这又要花费我2~3分钟,因为目标系统是一个项目结构比较乱的老框架系统。

    意外的是,当我翻看代码时,如下注释让我眼前一亮,随之顺藤摸瓜,我很顺畅地找到了我需要的东西。

    每当我看到这种有意义的注释,我会不自觉地在心里为这样的伙伴点赞!忍不住会点一下git的annotation,看看是谁这么优秀。

    众所周知,代码不光是写给机器执行的。更重要的,也是写给人看的,包括自己和他人。这些灯塔似的注释文字,往往会提高代码阅读性,也会大大提高我们解决问题的效率。

    鼓励大家为代码添加有意义的注释!

    当然,说起注释,再唠叨一嘴,利用javadoc注释规范的@see、@link更增强程序可读性。下面的呈现方式,在IDE里只需轻轻一点,便可春暖花开。

     

  • 相关阅读:
    java Udp协议简单的通讯
    java 简单装饰设计模式
    java 简单的拷贝文件夹
    java 简单的文件操作
    java 简单的进水放水
    java 洗牌 发牌
    less的在线安装
    移动端缩放设置
    less.js插件监听
    less使用
  • 原文地址:https://www.cnblogs.com/buguge/p/16294225.html
Copyright © 2020-2023  润新知