PEP8编码规范

目录

前言

Indentation缩进

单行字符限制

空行

源文件编码方式

注释

文档注释

模块和包相关规范

命名规范

---

前言

Guido（荷兰的一位计算机程序员）的一条重要见解就是代码阅读比写更加频繁。

我们都知道能写出程序很厉害，但是能写出好程序更厉害！！！

PEP8是针对python代码格式而编写的风格指南，下面跟着小编一起学习一下，让我们的代码变得更好看吧！

---

提示：以下是本篇文章正文内容，下面案例可供参考

Indentation缩进

每一级缩进使用4个空格（慎用Tab键，有的解释器中tab占4个空格，但并不是所有的）

• 隐式行连接缩进：对齐、层级缩进、\

• # 对齐缩进
  foo = dict(name="lh",age=18,
             gender="女",height=190)
  
  # 层级缩进
  def func(
          a,b=200,
          c=1000,d=2000)
      return a,b,c,d
  
  # 行连接\
  with open("txt1.txt") as f1,\
       open("txt2.txt") as f2:
      f1.read()
      f2.read()

单行字符限制

• 所有行限制的最大字符数为79个
• 没有结构化限制的大块文字（文档字符或注释），每行最大字符数限制为72个

空行

• 顶级函数和类的定义之间有两行空行
• 类内部的函数定义之间有一行空行

源文件编码方式

• Python核心发布中的代码应始终符合UTF-8编码方式
• Python3中不应该有编码声明

注释

• 如果注释很短，结尾句号可以省略。
  

  
  

  块注释一般由完整句子的一个或多个段落组成，并且每句话结束有个句号。
  

  
  

  在句尾结束的时候应该使用两个空格

• 注释并不是越多越好！！！

文档注释

• 文档注释应使用三个双引号或三个单引号来包裹    """内容"""或'''内容'''
• 要为所有的公共的模块、函数、类编写文档说明
• 非公共的方法没有必要添加文档注释，但应该有一个描述方法具体作用的注释，这个注释在def所在行之后

def add(a, b, c):
    '''
    这是一个计算方法
    '''
    return a+b+c

模块和包相关规范

• 位置：导入文件的顶部，在文档注释之后，在模块全局变量之前
• 导入顺序：标准库导入→第三方库导入→特定本地应用库导入

命名规范

• 变量命名：永远不要使用字母“l”，“O”作为单字符变量名，在有些字体里这些字符无法与数字0和1区分
• 函数命名：函数写应该小写，用下划线分割每一个单次
• 类命名：类名一般使用首字母大写的约定；在接口被文档化并且要被用于调用的情况下可以使用函数的命名风格代替；对于内置的变量命名有一个单独的约定：大部分内置变量是单个单词（或者两个单词连接在一起），首字符大写的命名只用于异常名或者内部变量
• 包和模块：模块的命名要短；使用小写；避免使用特殊字符；尽量保持模块名简单，不推荐使用两单词之间用下划线分开
• 常量：所有字母大写，单次用下划线分开