软件开发书写规范


软件开发目录规范

  • 目录规范并无固定的要求 主要符合清晰可读即可

bin文件夹

bin文件夹
	存放一系列启动文件(当启动文件很少或者只有一个的时候也可以直接写在外面)
    	start.py

conf文件夹

conf文件夹
	存放一些列配置文件
    	settings.py (一般情况下该文件内的变量名都是大写)

lib文件夹

lib文件夹
	存放公共的功能
    	common.py

db文件夹

db文件夹
	存放数据相关文件
    	userinfo.txt

log文件夹

log文件夹
	存放日志记录文件
    	log.txt

core文件夹

core文件夹
	存放项目核心代码文件
    	src.py

readme文件

readme文件
	存放说明相关信息 (类似于产品说明书  广告  章程)

requirements.txt

存放项目所需的第三方模块及版本号

为什么要规范软件开发目录

# 其实设计项目目录结构,就和我们写代码风格一样,属于个人风格问题。

# 但是规范化能够更好的控制程序结构,让程序具有更高的可读性

优点:
1.可读性高: 不熟悉这个项目的人,一眼就能看懂目录结构,知道程序启动脚本是那个,测试目录在哪里,配置文件在哪里等等。从而快速的了解项目
2.可维护性高:定义好组织规则后,维护者就能很明确的知道,新增的那个文件和代码应该放在什么目录之下。这样项目结构就不会混乱,可以良好的组织软件。

# 所以规范的软件开发目录是很有必要的!!!

上述就是一个比较完成的软件开发目录