《编写可读代码的艺术》《第5章 该写什么样的注释》

1. 了解什么不需要注释

2. 用代码记录你的思想

3. 站在读者的角度，去想象他们需要知道什么

好代码 > 坏代码 + 注释

 

为代码中的瑕疵写注释：

TODO： 我还没有处理的事情

FIXME： 已知的无法运行的代码

HACK： 对一个问题不得不采用的比较粗糙的解决方案

XXX: 危险，这里有重要的问题

 

给常量加注释

posted @   清风oo  阅读(138)  评论(0)  编辑  收藏  举报
编辑推荐：
· 开发者必知的日志记录最佳实践
· SQL Server 2025 AI相关能力初探
· Linux系列：如何用 C#调用 C方法造成内存泄露
· AI与.NET技术实操系列（二）：开始使用ML.NET
· 记一次.NET内存居高不下排查解决与启示
阅读排行：
· Manus重磅发布：全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后，我竟然真的恢复了删除的微信聊天记录！
· 没有Manus邀请码？试试免邀请码的MGX或者开源的OpenManus吧
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
· 【自荐】一款简洁、开源的在线白板工具 Drawnix
点击右上角即可分享
微信分享提示