程序规范示例
1 为什么需要进行程序规范?
- 可读性
- 可维护性
2 程序如何规范?
举个简单的例子,如果我们要创建一个Foo项目
Foo/ |--bin/ | |--foo | |--foo/ | |--tests/ | | |--__init__.py | | |--test_main.py | | | |--__init__.py | |--main.py | |--docs/ | |conf.py | |abc.rst | |--setup.py |--requirments.txt |--README
3 分别是什么意思?
- bin/:存放可执行文件。
- foo/:存放项目的所有源代码。
- 所有模块都应该放到此目录中。不要置于顶层目录
- 子目录test/单元存放测试代码
- 程序入口命名为:main.py
- docs/:存放其他文档
- setup.py:安装、部署、打包的脚本
- requirement.txt:存放软件依赖的外部python目录
- README项目说明文件
4 README中应该包括些什么?
- 软件定位,主要功能
- 运行代码方法:1 安装环境 2 启动命令
- 简要使用说明
- 代码目录说明,说明软件的基本原理
- 常见问题说明
加相对路径,让你的程序能够在所有设备上都可以使用
新需求:模拟实现ATM+购物车的功能
- 额度15000
- 实现购物商城,买东西加入购物车,调用信用卡接口
- 可以提现,手续费5%
- 支持多账户登陆
- 账户间相互转账
- 记录每月日常消费流水
- 提供还款接口
- ATM记录操作日志
- 提供管理接口,包括添加账户、用户额度、冻结账户等
- 用户认证用装饰器