软件开发规范

时间:2022-12-15 09:13:17
'''
一、设计好目录结构:
1.可读性高
2.可维护性高
二、目录组织方式:
组织一个较好的Python工程目录结构,已经有一些得到了共识的目录结构:
假设你的项目名为ATM:

ATM/
|-- bin/
| |-- __init__
|  |-- start.py
|
|-- core/
| |-- tests/
| | |-- __init__.py
| | |-- test.main.py
| |
| |-- __init__.py
| |-- test_main.py|
|
|-- conf/
| |-- __init__.py
| |-- setting.py
|
|---db/
| |--db.json
|
|-- docs/
|
|-- lib/
| |-- __init__.py
| |-- common.py
|
|-- log/
| |-- access.log
|
|-- __init__.py
|-- README


bin/: 存放项目的一些可执行文件,当然你可以起名script/之类的也行,但bin/更直观。易懂
core/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。 (2) 其子目录tests/存放单元测试代码; (3) 程序的入口最好命名为main.py。
conf/:配置文件。
db/:数据库文件。
lib/:库文件,放自定义模块和包。
docs/: 存放一些文档。
log/: 日志文件。
README: 项目说明文件。
注:运行程序时,在bin目录下执行start.py代码,不可以直接执行core下的模块。
'''



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

'''

'''
setup.py文件:
一般用setup.py来管理代码的打包、安装、部署问题。
业界标准的写法是用python流行的打包工具setuptools来管理。
一个项目一定要有一个安装部署工具,能快速便捷地在一台新机器上将环境装好、代码部署好和程序运行起来。
'''

'''
缩进:
使用4个空格缩进,禁止使用tab缩进。
把单行内容拆成多行写时,要么与首行保持对齐;要么首行留空,从第二行起统一缩进4个空格;为与后面的代码区分,可以使用8空格缩进。

解释:
不同编辑器对TAB的设定可能不同,使用TAB容易造成在一些编辑器下代码混乱,所以建议一率转换成空格。

在vim下,建议打开如下设置:
:set tabstop=4 设定tab宽度为4个字符
:set shiftwidth=4 设定自动缩进为4个字符
:set expandtab 用space自动替代tab
'''