【代码重构】过多注释(Comments)--如何解决代码中过多注释？

过多注释（Comments)

●症状和特点

   一个方法中充斥着解释性的注释。

●问题产生的原因

   当作者意识到他或她的代码不直观或不明显时，注释通常是怀着最好的意图创建的。在这种情况下，注释就像一种除臭剂，掩盖了可以改进的可疑代码的气味。
   如果你觉得没有注释就无法理解代码片段，请尝试以一种使注释变得不必要的方式更改代码结构。

●解决方法

   如果注释的目的是解释复杂的表达式，则应该使用提取变量法将该表达式拆分为可理解的子表达式。
   如果注释解释了一段代码，可以通过提炼方法法将这段代码转换为一个单独的方法。新方法的名称很可能取自于之前这段代码的注释。(也就是通过将代码提取成方法，通过这个新方法的名字来替代原来的注释）
   如果一个方法已经被提炼过（用以上方法重构），但是仍然需要注释来解释该方法的功能，那么就通过方法重命名法给该方法一个具有解释自身功能的名称。
   如果您需要断言关于系统工作所必需的状态的规则，请使用引入断言法。

●好处

   代码变得更加直观和明显。

●何时需要忽略

   注释有时很有用:

   当解释为什么某些东西要以一种特定的方式执行时。

   当解释复杂的算法时(当所有其他简化算法的方法都尝试过但都失败了)。