写还是不写注释？

简评：这篇文章出自 Google Testing blog 的 Code Health 系列，推荐大家可以关注一下。

当我们看代码的时候，最舒服的莫过于看到有一个写得很好的注释了。但是，注释也不总是能帮上忙的，有时你觉得一段代码需要注释，往往也是代码需要重构的标识。

在你决定需要写注释之前，可以先试试下面的操作：

• 定义一个解释变量：

• 提取成方法：

• 使用更具体的变量名：

• 增加检查：

不过有些情况下，注释也是会有帮助的：

• 说明你的意图：解释为什么做某事而不是做了什么。
  // Compute once because it’s expensive
• 解释在代码审查时其他人可能会疑惑的问题。
  // Note that order matters because...
• 解释你为什么使用了一个看上去不太好的做法。
  @SuppressWarnings("unchecked") // The cast is safe because...

另外，一定要避免写那些别人能直接从代码中看出来的注释，这些只会是噪音：

原文：testing.googleblog.com/