一个好的目录结构,不仅可以形成规范,还可以增加代码的可读性、可维护性、减少 Bug。相反,一个不合理的目录结构会带来很多问题,比如说:
- 功能目录缺失:想添加一些功能,但发现没有相应的目录,只能随意创建一个目录或者将功能放在了一个不适合的目录下,造成目录结构和功能混乱,进而造成代码难以阅读和维护。
- 目录功能不明确:看目录名,获取不到目录所实现的功能,例如common、const、util这类目录名。在开发代码时,功能A因为没有明确地存放功能A的目录,就会给我们开发造成困扰。在阅读代码时,不知道功能A存放的目录,会给我们维护、阅读代码带来一些难度。
- 代码重复率高:在开发新功能时,可能会用到功能A,但因为不知道功能A存放在哪个目录而找不到功能A,就需要可能新开发一个功能A。这就会导致代码重复,增加代码的重复率,降低代码质量。重复造轮子,不仅违背了软件设计原则,而且还会增加后面代码变更的成本。
- ......
更要命的是,这些问题会随着项目的迭代、代码量的增加越来越严重,所以我们最好从一开始就规划一个合理的目录结构。