python编码规范简单总结

编码规范方面

一、命名规范

1. 变量名通常由字母,数字,下划线组成;
2. 数字不能作为变量名开头;
3. 不能以python中的关键字命名;
4. 变量名要有意义;
5. 不要用汉字和拼音去命名;
6. 变量名要区分大小写;
7. 推荐使用驼峰型来命名;
8. 常量通常使用大写来定义.

二、注释规范

1. python中的单行注释是以 # 开头的，被注释的任何内容都会忽略，不会输出。
2. 为了代码规范，一般#井号需后要加一个空格。
3. 而多行注释可以使用个单引号'''或者三个双引号 """。
4. 注意单引号或者双引号必须是英文下的单引号或双引号，而且必须是成对出现的。

三、标识符规范

1. 标识符是由字母、下划线和数字组成，且不能以数字开头。
2. 第一个字符必须是字母表中字母或下划线 _
3. python中的标识符是区分大小写的
4. 关键字是python已经使用的了，所以不允许开发者自己定义和关键字相同的名字的标示符，也就是说关键字不能作为标识符使用

四、字符转义规范

和很多编程语言一样，反斜线 加上字符会自动转义，如果想打印原样字符，再加一个反斜线 ，两个反斜线加上字符即可。

五、缩进规范

1. 在一个源文件不建议同时使用空格和制表缩进符，当使用别人代码的时候几乎是不可能知道别人使用的是空格还是制表符，这时最好统一缩进.

1. Python中的每一条语句都有一个缩进级别,并且缩进级别会使用栈的数据结构进行存储。在开始读取文件之前，0（表示缩进级别为0，无缩进）会被首先压入栈中。然后从文件开头到末尾，依次读取每行逻辑代码，每行逻辑代码的缩进级别都会和栈顶值进行比较，如果相等，那么什么都不会发生；如果比栈顶值大的话，那么该行逻辑代码的缩进级别就会被压入栈中，同时会生成一个缩进标记;如果比栈顶值小的话，那么栈中所有比该行逻辑代码缩进级别大的值都会从栈中移除，并且还会生成一个扩展标记。

六、代码编排

1. 缩进。4个空格的缩进（编辑器都可以完成此功能），不要使用Tap，更不能混合使用Tap和空格。
2. 每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。
3. 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

七、文档编排

1. 模块内容的顺序：模块说明和docstring—import—globals&constants—其他定义。其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。
2. 不要在一句import中多个库，比如import os, sys不推荐。如果采用from XX import XX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用import XX。

八、空格的使用：总体原则，避免不必要的空格。

1. 各种右括号前不要加空格。
2. 逗号、冒号、分号前不要加空格。
3. 函数的左括号前不要加空格。如Func(1)。
4. 序列的左括号前不要加空格。如list[2]。
5. 操作符左右各加一个空格，不要为了对齐增加空格。
6. 函数默认参数的赋值符左右省略空格。
7. 不要将多句语句写在同一行，尽管使用‘；’允许。
8. if/for/while语句中，即使执行语句只有一句，也必须另起一行。

九、注释

1. 总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。
2. 块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。
3. 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x但是这种方式尽量少使用。
4. 避免无谓的注释。

十、文档描述

 为所有的共有模块、函数、类、方法写docstrings；非共有的没有必要，但是可以写注释（在def的下一行）。

十一、小组团队合作方面

1. 将同学当作平等的伙伴
2. 让同学参与到合作中
3. 在团队上花足够的时间，但不要忽视其他职责
4. 期待高标准，但不要逼迫大家
5. 给同学留下空间来试验和学习

十二．作为负责人如何带领团队

1.总结自己一天的计划完成情况，考虑明天应该做的主要工作，考虑自己一天工作当中失误的地方

2.修炼8种能力

1. 脾气一定要控制好
2. 遇事莫慌
3. 记住抱怨是没有用的
4. 要相信你的团队成员，多鼓励他们
5. 注意客观公正
6. 功劳不是自己的

软件开发相关规范文档

1,可行×××报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

2, 项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

3,软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

4,数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

5, 概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

6, 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

7,用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

8,操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

9, 测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

10,测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。

11, 开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

12, 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。

13,软件维护修改建议:此是为后期维护修改做记录报告用的.