北京
分享至
今天收到一份外包团队交付的代码，里面有一条注释让审核者愣了三秒——除了一个Stack Overflow链接，什么都没有。
这条注释来自Nona的投稿。按理说，指向技术社区的链接本身并不稀奇，很多开发者习惯用这种方式标注参考来源。问题在于，这条注释孤零零地躺在那里：没有说明要解决什么问题，没有解释链接里的方案如何被采用，甚至没有被包裹在代码块里。
想象一下接手这份代码的人的心情。看到那个URL，你得先点开、读完整个问答帖，再回头猜这里到底在干什么。原本几秒钟能理解的逻辑，变成了一场考古。
技术债常常就是这样欠下的。不是代码写得多烂，而是那个"当时显然"的上下文，随着时间变成了谜团。一条合格的注释至少该回答：为什么需要这个方案，而不是别的。
链接可以附，但别让下一个读代码的人，去替你完成解释的工作。
特别声明：以上内容(如有图片或视频亦包括在内)为自媒体平台“网易号”用户上传并发布，本平台仅提供信息存储服务。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.
