危险信号摘要
Last updated
Last updated
下面是本书中讨论的一些最重要的危险信号。在一个系统中出现任何这些症状,都表明系统的设计存在问题。
浅模块:一个类或方法的接口并不比它的实现简单多少(见)。
信息泄露:一个设计决策反映在多个模块中(见)。
时序分解:代码结构是基于操作的执行顺序,而不是基于信息隐藏(见)。
过曝:一个API迫使调用者了解很少使用的功能,以便使用常用的功能(见)。
传递式方法:一个方法除了将其参数传递给另一个具有类似签名的方法外,几乎什么都不做(见)。
重复:一段不重要的代码被不断地重复(见)。
特殊-普通混合体:特殊用途的代码与普通用途的代码没有干净地分开(见)。
连体方法:两个方法有很多依赖关系,如果不了解另一个方法的实现,就很难了解一个方法的实现(见)。
注释重复代码:注释中的所有信息都可以从注释旁边的代码中一眼看出(见)。
实现文档污染了接口:接口注释描述了用户不需要的实现细节(见)。
含糊不清的名称:一个变量或方法的名称非常不精确,以至于没有传达多少有用的信息(见)。
难以取名:很难为一个实体想出一个精确而直观的名字(见)。
难以描述:为了做到完整,一个变量或方法的文档必须很长。(见)。
不易于理解的代码:一段代码的行为或意义不能被轻易理解。(见)。