软件开发规范

一、什么是开发规范?为什么要有开发规范呢?

​ 你现在包括之前写的一些程序，所谓的'项目'，都是在一个py文件下完成的，代码量撑死也就几百行，你认为没问题，挺好。但是真正的后端开发的项目，系统等，少则几万行代码，多则十几万，几十万行代码，你全都放在一个py文件中行么？当然你可以说，只要能实现功能即可。咱们举个例子，如果你的衣物只有三四件，那么你随便堆在橱柜里，没问题，咋都能找到，也不显得特别乱，但是如果你的衣物，有三四十件的时候，你在都堆在橱柜里，可想而知，你找你穿过三天的袜子，最终从你的大衣口袋里翻出来了，这是什么感觉和心情......

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

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

二、为什么要设计项目目录结构？

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

1、一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。

2、另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性

“项目目录结构”其实也是属于“可读性和可维护性”的范畴，我们设计一个层次清晰的目录结构，就是为了达到一下两点：

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

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

所以，我认为，保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

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

blog

• bin

  • start.py # 开启项目的start文件

• conf

  • settings.py # 配置文件，放一些路径或者信息配置

• core

  • src.py # 逻辑部分：核心逻辑，代码放在这。

• db

  • db.json # 重要数据都放在这里

• lib

  • commom.py # 公共组件放在这里：公共功能部分。

• log

  • access.log # 日志信息

  README

四、关于README的内容

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

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

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

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