评论

迹象和症状

方法由解释性注释填充。

问题的原因

注释通常是出于最好的意图创建的，当作者意识到他或她的代码不直观或不明显时。在这种情况下，注释就像一种除臭剂，掩盖了可以改进的可疑代码的气味。

最好的注释是一个方法或类的好名字。

如果您觉得没有注释就无法理解代码片段，请尝试以一种不需要注释的方式更改代码结构。

治疗

• 如果注释的目的是解释一个复杂的表达式，则应该将该表达式分解为易于理解的子表达式提取的变量．

• 如果一个注释解释了一段代码，这段代码可以被转换成一个单独的方法提取方法．新方法的名称很可能来自注释文本本身。

• 如果已经提取了一个方法，但仍然需要注释来解释该方法的功能，则给该方法起一个自解释的名称。使用重命名方法对于这个。

• 如果您需要断言关于系统工作所必需的状态的规则，请使用介绍断言．

回报

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

何时忽略

注释有时很有用:

• 当解释为什么某些东西正在以特定的方式实现。

• 当解释复杂的算法时(当所有其他简化算法的方法都已经尝试过，但都不成功时)。