编写可读代码的艺术2

如何写注释

很多人认为注释只是解释代码做了什么，其实注释的根本作用是记录关键思想，帮助读者了解和作者一样多。

不要为那些从代码本身就能快速推断的事实写注释


不要为了注释而注释

记录你的思想

为代码瑕疵注释
给常量加注释

公布可能的陷阱

全局观解释

总结性注释