python软件开发规范

软件开发规范：

---

1. 为什么要有规范化目录

   代码分类:

   ​ 加载快.

   ​ 可读性高.

   ​ 查询修改都简单.

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

2. 分析规范化目录.

   1. 划归固定的路径:
   2. settings.py文件：配置文件，就是放置一些项目中需要的静态参数，比如文件路径，数据库配置，软件的默认设置等等
   3. src.py 主逻辑核心逻辑文件,
   4. common.py 公共组件部分，这里面放置一些我们常用的公共组件函数，并不是我们核心逻辑的函数，而更像是服务于整个程序中的公用的插件，程序中需要即调用。比如我们程序中的装饰器auth，有些函数是需要这个装饰器认证的，但是有一些是不需要这个装饰器认证的，它既是何处需要何处调用即可。比如还有密码加密功能，序列化功能，日志功能等这些功能都可以放在这里。
   5. start.py文件:项目启动文件
   6. 类似于register文件: 用户信息,数据相关,多个文件.
   7. logging日志文件: 记录用户的访问次数,转账,取钱,充钱等等.以及用户干了什么.

3. 为什么要设计项目目录结构？

   1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。

   2. 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

4. 关于README的内容

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

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