软件开发,规范你的项目目录结构,代码规范,遵循PEP8规范等等,让你更加清晰滴,合理滴开发。
软件开发的首要规范就是从设计目录结构开始。
二、为什么要设计项目目录结构?
"设计项目目录结构",就和"代码编码风格"一样,属于个人风格问题。对于这种风格上的规范,一直都存在两种态度:
-
一类同学认为,这种个人风格问题"无关紧要"。理由是能让程序work就好,风格问题根本不是问题。
-
另一类同学认为,规范化能更好的控制程序结构,让程序具有更高的可读性
“项目目录结构”其实也是属于“可读性和可维护性”的范畴,我们设计一个层次清晰的目录结构,就是为了达到一下两点:
-
可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。
-
可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。
所以,我认为,保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录,其实是一件很简单的事儿。
三、较好的目录结构方式(推荐)
blog
-
bin
-
start.py # 开启项目的start文件
-
-
conf
-
settings.py # 配置文件,放一些路径或者信息配置
-
-
core
-
src.py # 逻辑部分:核心逻辑,代码放在这。
-
-
db
-
db.json # 重要数据都放在这里
-
-
lib
-
commom.py # 公共组件放在这里:公共功能部分。
-
-
log
-
access.log # 日志信息
README
-
四、关于README的内容
这个我觉得是每个项目都应该有的文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。
它需要说明以下几个事项:
-
软件定位,软件的基本功能。
-
运行代码的方式:安装环境,启动命令等。
-
简要的使用说明。
-
代码目录结构说明,更详细点可以说明软件的基本原理。
-
常见问题说明。
我觉得有以上几点是比较好的一个README