作为一个技术小leader，在排查生产问题时，我经常要周转于各个工程里。系统和服务多起来后，要我了解每一段代码具体的来龙去脉逐渐变得不可能。
例如，今天，我要查一下调用外部的一个接口给的编码值。就按自己的印象趴代码。我下意识里感觉到又需要花费我2~3分钟，因为目标系统是一个比较乱的老框架系统。
意外的是，当我翻看代码时，如下注释让我眼前一亮，随之顺藤摸瓜，我很顺畅地找到了我需要的东西。
每当我看到这种有意义的注释，我会不自觉的在心里为这样的伙伴点赞！忍不住会点一下git的annotation，看看是谁这么优秀。
众所周知，代码不光是写给机器执行的。更重要的，也是写给人看的，包括自己和他人。每当在分析问题时，这些明灯似的的注释文字，就会大大提高我们排障效率。
鼓励大家为代码添加有意义的注释！
当然，说起注释，再唠叨一嘴，利用javadoc注释规范的@see、@link更增强程序可读性。下面的呈现方式，在IDE里只需轻轻一点，便可春暖花开。
标签：写给,要查,代码,系统,总能,注释,得体,每当,TA 来源： https://www.cnblogs.com/buguge/p/16294225.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。