程序规范示例

1 为什么需要进行程序规范？

1. 可读性
2. 可维护性

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 分别是什么意思？

1. bin/：存放可执行文件。
2. foo/：存放项目的所有源代码。
   1. 所有模块都应该放到此目录中。不要置于顶层目录
   2. 子目录test/单元存放测试代码
   3. 程序入口命名为：main.py
3. docs/：存放其他文档
4. setup.py：安装、部署、打包的脚本
5. requirement.txt：存放软件依赖的外部python目录
6. README项目说明文件