软件开发规范
一、设计好目录结构
可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,从而非常快速的了解这个项目。
可维护性高: 定义好组织规则后,维护者就能很明确地知道,
新增的哪个文件和代码应该放在什么目录之下。
这个好处是,随着时间的推移,代码 / 配置的规模增加,
项目结构不会混乱,仍然能够组织良好。
二、目录组织方式
关于如何组织一个较好的Python工程目录结构,已经有一些得到了共识的目录结构。
假设项目名为ATM
bin /: 存放项目的一些可执行文件,当然你可以起名script / 之类的也行,但bin / 更直观。易懂
core /: 存放项目的所有源代码。(1)
源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。 (2)
其子目录tests / 存放单元测试代码; (3)
程序的入口最好命名为main.py。
conf /:配置文件。
db /:数据库文件。
lib /:库文件,放自定义模块和包。
docs /: 存放一些文档。
log /: 日志文件。
README: 项目说明文件。
注:运行程序时,在bin目录下执行start.py代码,不可以直接执行core下的模块。