Python高质量代码--1

一、规范一

1）避免只用大小写来区分不同的对象，例如用a表示一个数值类型变量，用A表示String类型变量；

2）避免使用容易引起混淆的名称，比如：重复使用已经存在于上下文中的变量名来表示不同的类型；误用了内建名称来表示其他含义的名称而使之在当前命名空间被屏蔽；使用o、l等作为变量名；

3）不要害怕过长的变量名，变量名person_info比pi的可读性要强得多；

4）使用风格检查程序PEP8进行编程规范的检查，比如flake8、Pylint。

二、规范二

1）统一缩进风格，不要混用Tab与空格，用四个空格代替Tab键；

2）在Python中，单引号与双引号没有区别，在使用时尽量统一；

3）三元操作符在python中的形式为X if C else Y；

4）python中没有switch，可以使用字典跳转表来实现。

三、规范三

1）python中有3种形式的代码注释：块注释、行注释以及文档注释；

2）注释要清楚描述方法的功能，并对参数、返回值以及可能发生的异常进行说明，使得外部调用它的人员仅仅看docstring就能正确使用；

3）推荐在文件头中包含copyright声明、模块描述等，如有必要，可以考虑加入作者信息以及变更记录。

四、规范四

1）在一组代码表达完一个完整的思路之后，应该使用空白行进行分割；

2）尽量保持上下文语义的易理解性；

3）避免过长的代码行，每行最好不要超过80个字符，过长行用\分割；

4）不要为了保持水平对齐而使用多余的空格；

5）在疏松关系的实体间用空格起到分隔作用，而在具有紧密关系的时候不要使用空格。

五、规范五

1）函数设计要尽量短小，嵌套层次不宜过深，最好能控制在3层之内；

2）函数申明应该做到合理、简单、易于使用，参数个数不易太多；

3）函数参数设计应该考虑向下兼容；

4）一个函数只做一件事，尽量保证函数语句粒度的一致性。