软件的开发规范

 

为什么要有规范软件开发。

　　真正的后端开发的项目，系统等，少则几万行代码，多则十几万，几十万行代码，你全都放在一个py文件中行么？咱们举个例子，如果你的衣物只有三四件，那么你随便堆在橱柜里，没问题，咋都能找到，也不显得特别乱，但是如果你的衣物，有三四十件的时候，你在都堆在橱柜里，可想而知，你找你穿过三天的袜子，最终从你的大衣口袋里翻出来了，这是什么感觉和心情......

　　软件开发，规范你的项目目录结构，代码规范，遵循PEP8规范等等，让你更加清晰滴，合理滴开发。

　　软件开发的首要规范就是从设计目录结构开始。

 

--项目名称
    -- bin  一个项目的启动文件装在这个文件夹下
        -- strat.py
    -- conf config配置,配置文件
        -- settings.py 可能会发生改变的配置信息
    -- core 核心代码
        -- 相关文件 实际的python代码所在的文件
　　　　例如:
        -- user.py
        -- auth.py
        -- main.py
    -- lib  第三方库
    -- db   database 数据库 一堆数据文件,不一定是py文件
    -- log  日志

此外,还可以有readme文件:

目的是能简要描述该项目的信息，让读者快速了解这个项目。

它需要说明以下几个事项:

1. 软件定位，软件的基本功能。
2. 运行代码的方法: 安装环境、启动命令等。
3. 简要的使用说明。
4. 代码目录结构说明，更详细点可以说明软件的基本原理。
5. 常见问题说明。