软件开发目录规范

软件开发目录规范

为了提高程序的可读性和可维护性，我们应该为软件设计良好的目录结构。

目录结构

具体目录结果如下：

project/ #项目名
|-- core/   #存放业务逻辑相关的代码
|   |-- core.py
|
|-- api/  #存放接口文件，接口主要用于业务逻辑提供数据操作
|   |-- api.py
|
|-- db/   #存放操作数据库相关文件，主要用于数据交互
|   |-- db_handle.py
|
|-- lib/  #存放自定义的模块，会被多处导入
|   |-- common.py
|
|-- conf/  #存放配置文件
|   |-- settings.py
|
|-- run.py #启动文件，一般 放在项目的根目录下
|-- setup.py #安装、部署、打包的脚本
|-- requirements.txt #存放软件依赖的外部 python 包列表
|-- README #项目说明书

注：run.py为启动文件，一般存放在项目的根目录下，因为在运行时会默认将运行文件所在的文件夹作为 sys.path的第一个路径，这样就省去了处理环境变量的步骤

关于 readme

关于README的内容，这个应该是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。它需要说明以下几个事项:

1、软件定位 、软件的基本功能

2、运行 代码的方法：安装环境、启动命令等

3、简要的使用说明

4、代码目录结构说明，更详细可以说明软件的基本原理

5、常见问题说明