python 软件开发目录规范

软件开发目录规范

1、前言

软件开发的过程中，需要规范的东西有很多，比如要写引言，市场可行性以及技术可行性，社会可行性，评论测试等，本文介绍了软件开发目录的规范实例，一方面为了提升程序的可读性与可维护性，我们在开发的过程中可以为自己的软件设计具有层次以及良好的目录结构，这与python编码规范（PEP8）一样，需要规范自己的目录，清晰可读即可！

---

举个栗子：我们的衣柜里存放衣服的时候，肯定是会分门别类的，比如冬天的衣服放一起，夏天的衣服放一起，或者上衣放一起，袜子放一起，裤衩子，吊带放一起·····说偏了说偏了扯回来，开发目录也要分门别类！

---

2、文件分类详细

1. bin文件夹：
   • 存放一系列启动文件，当启动文件很少或者只有一个的时候可以写在外边>>>start.py
2. conf文件夹：
   • 存放一系列的配置文件，一般情况该文件内的变量名都是大写>>>settings.py
3. lib文件夹：
   • 存放公共的功能>>>common.py
4. db文件夹：
   • 存放数据相关文件>>>userinfo.txt
5. log文件夹：
   • 存放日志记录文件>>>log.txt
6. core文件夹：
   • 存放项目核心代码文件>>>src.py
7. readme文件:
   • 存放说明相关信息（类似于说明书，广告，章程···）
8. requirements.txt文件：
   • 存放项目所需的第三方模块及版本号

---

requirements.txt文件说明

这个文件的存在是为了方便开发者，维护软件的依赖库，我们需要的第三方库都可以写进去，pycharm非常智能，会通过识别版本号以及包名导入，这样也方便我们查看使用了哪些python包。

• 写入格式必须能被pip识别
• eg:Library>=0.2

pip格式详情👉[pip导入格式](Requirements files — pip 1.1 documentation (pypa.io))

---

规范目录图示：

---

祝各位写得一手好bug~