PEP8 规范

PEP8 代码规范

pycharm的代码编排：

　　缩进：使用4个空格，可以直接 Tab 键

　　换行：换行可以直接设置自动换行，但是由于pep8规范，可以使用 \ 来换行

　　空行：1、类与其他函数或代码之间要空两行，前后都要；

　　　　　2、类里面的函数方法之间要空一行；

　　　　　3、其他地方尽量不要空行。

 

pycharm文档的编排：

　　模块：模块内容的顺序：

　　　　　1、先写模块说明，可以写多行字符串(文档字符串)；

　　　　　2、写import xxx；模块的导入顺序：先写标准模块、再写第三方模块、最后是自己的模块；

　　　　　　  最好三者之间隔一行。

　　　　　3、写全局变量和常数。

　　模块导入：不要用一个import导入几个模块，如：import numpy,os

　　from xx import xx ：这种方式，有可能会有冲突；如：from dan import student 和from sglor inport student;

　　　　　这里有两个student，所以可以直接用import xx的方式。

 

空格的使用：

　　1、各种括号的前面不要加空格，括号的右括号前也不要和内容有空格；如：print('' ),应该删除这个空格；

　　2、冒号，逗号，分号前不要加空格，后面叫一个空格；

　　3、操作符的前后都加一个空格。操作符：运算符...

　　4、函数默认参数使用的赋值符左右省略空格；

　　5、不要将多个语句写在一行；虽然可以用 ；号，这也是允许的，但是不好；

　　6、if/for/which 这些语句，就算只有一个语句也要另起一行。

 

注释：

　　1、在一句语句末注释，#符号与内容之间要有一个空格，如：# 123

　　2、少在代码后注释，尽量使用行注释；

 

文档注释：

　　在pycharm中注释（多行字符串注释）的时候，不要使用 ''' '''，要使用""" """，即双引号而不是单引号

　　如：

class Animal:

　　"""

　　这是一个类注释

　　"""

　　pass

 

命名的规范：

　　1、模块命名尽量短，使用全部小写的方式，可以使用下划线；

　　2、包命名尽量短，使用全部小写的方式，并且不可以使用下划线；

　　3、类命名时，要使用单词串，并且首字母大写，如：class AnimalDog:...

　　4、函数命名使用全部小写的方式，可以使用下划线；

　　5、常量命名使用全部大写的方式，可以使用下划线；

 

异常问题：

　　1 、尽可能使用 ‘is’ 或 ‘is not’ 取代 ‘==’，比如 if x is not None 要优于if x ；

　　2 、使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception；

　　3 、异常中不要使用裸露的except，except后跟具体的exceptions；

　　5 、异常中try的代码尽可能少。比如：