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

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

例如，今天，我要查一下调用外部的一个接口给的编码值。就按自己的印象趴代码。我下意识里感觉到又需要花费我2~3分钟，因为目标系统是一个比较乱的老框架系统。

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

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

众所周知，代码不光是写给机器执行的。更重要的，也是写给人看的，包括自己和他人。每当在分析问题时，这些明灯似的的注释文字，就会大大提高我们排障效率。

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

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

标签：写给,要查,代码,系统,总能,注释,得体,每当,TA
来源： https://www.cnblogs.com/buguge/p/16294225.html