PEP8 Python代码规范

2,046 阅读2分钟

你好,我是悦创。

一、PEP8简介

PEP8是一份关于Python编码规范指南, 遵循该规范能够帮助Python开发者编写出优雅的代码, 提高代码的可读性.

Python PEP8 编码规范官方文档:www.python.org/dev/peps/pe…

Python PEP8 编码规范中文版:www.python.org/dev/peps/pe…

二、代码规范

详细规范可查看Python PEP8 编码规范官方文档Python PEP8 编码规范中文版

(1) 代码布局

  • 缩进: 每个缩进使用4个空格, 不推荐使用Tab, 禁止混用空格与Tab
  • 行的最大长度: 每行最大长度79, 换行可以使用反斜杠, 但建议使用圆括号
  • 空白行: 顶层函数和定义的类之间空两行, 类中方法定义之间空一行; 函数内逻辑无关的代码段之间空一行, 其他地方尽量不要空行

(2) 空格的使用

  • 右括号前不要加空格
  • 逗号、冒号、分号前不要加空格
  • 函数的左括号前不要加空格, 如 fun(1)
  • 序列的左括号前不要加空格, 如 list[2]
  • 操作符左右各加一个空格, 如 c = a + b
  • 不要将多条语句写在同一行
  • if、for、while语句中, 即使执行语句只有一句, 也必须另起一行

总结

  • 前不加空格
  • 操作符左右各加一个空格
  • 不要写在同一行

(3) 代码注释

  • 块注释: 块注释跟随被注释的代码,缩进至与代码相同的级别. 块注释使用”#”开头
  • 行内注释: 与被注释的代码同行, 注释使用”#”开头, 与被注释的代码至少有两个空格分隔
  • 文档字符串: 文档字符串指为所有公共模块、函数、类及方法编写的文档说明. 文档字符串使用三引号包裹

(4) 命名规范

  • 不要使用字母 “l”(L的小写)、”O”(大写O)、”I”(大写I)作为单字符变量名
  • 模块名、包名应简短且全为小写
  • 函数名应该小写, 可以使用下划线分隔小写单词
  • 类名首字母一般使用大写
  • 常量通常采用全大写命名

(5)变量命名规范

  • 有字母、数字、和下划线组成, 且不以数字开头
  • 区分大小写
  • 通熟易懂, 见名知意
  • 如果由两个及以上单词组成,单词与单词之间使用下划线连接

AI悦创·推出辅导班啦,包括「Python 语言辅导班、C++辅导班、算法/数据结构辅导班、少儿编程」,全部都是一对一教学:一对一辅导 + 一对一答疑 + 布置作业 + 项目实践等。QQ、微信在线,随时响应!V:Jiabcdefh