Python正课51 —— 软件开发目录规范

本文内容皆为作者原创，如需转载，请注明出处：https://www.cnblogs.com/xuexianqi/p/12593532.html

软件开发目录规范：

- api   存放接口文件，接口主要用于为业务逻辑提供数据操作
    - api.py --> 应用程序编程接口

- bin   整个项目的启动文件放置在这个文件夹中
    - start.py --> 启动软件入口

- conf  整个项目的配置文件放置在这个文件夹
    - settings.py   配置文件
        - 比如存放一些固定的路径

- core  整个项目的核心文件
    - src.py 核心业务逻辑代码 （第一层：用户视图层：核心业务逻辑代码）

- db    用于存放数据文件与操作数据的代码文件
    - db_file ---> db.txt ...
    - db_handler.py ---> 操作数据的代码 （第三层：数据处理层）
    
- interface   用于存放用户接口
    - user_interface.py ---> 第二层：用户接口

- lib   项目的第三方包，共享的一些库
    - common: 存放公共的功能
        - 比如存放 装饰器

- log	用于存放项目的日志文件
    - log.txt  存放日志的文件

- README.TXT    整个项目的说明文件，项目需求和大致流程，相当于产品说明书

README.TXT的内容

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

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

3、简要的使用说明；

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

5、常见问题说明。

开发大致架构图