day31-软件开发规范

一、为什么要规范软件开发/h2>

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

　　之前写的一些程序，所谓的’项目’，都是在一个py文件下完成的，代码量也就几百行，没有太大问题。但是真正的后端开发的项目，少则几万行代码，多则十几万，几十万行代码，就不能全都放在一个py文件中了。

　　软件开发，规范项目目录结构，代码规范，遵循PEP8规范等等，让代码结构更清晰。

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

1.2 为什么要设计项目目录结构/strong>

　”设计项目目录结构”，就和”代码编码风格”一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度:

一类同学认为，这种个人风格问题”无关紧要”。理由是能让程序work就好，风格问题根本不是问题。
另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。
我是比较偏向于后者的，”项目目录结构”其实也是属于”可读性和可维护性”的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱。
所以，保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

二、较好的目录结构方式（推荐）

关于README的内容

每个项目都应该有的一个readme文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。

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

有以上几点是比较好的一个README。在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。

可以参考Redis源码中Readme的写法，这里面简洁但是清晰的描述了Redis功能和源码结构。

文章知识点与官方知识档案匹配，可进一步学习相关知识Python入门技能树桌面应用开发Tkinter208731 人正在系统学习中 相关资源：城市规划常用软件湘源控规_湘源镇区规划-咨询工具类资源-CSDN文库