首页Python+大数据技术文章正文

Python程序编写规范【编程约定】

更新时间:2022年05月23日16时05分来源:传智教育浏览次数:

程序的编码风格是一个人编写程序时表现出来的特点、习惯逻辑思路等。我们在程序开发时要重视其编写规范，程序不仅应该能够在机器上正确执行，还应便于调试、维护及阅读。

PEP8是一份关于Python编码规范指南，遵守该规范能够帮助Python开发者编写出优雅的代码，提高代码可读性。下面举例说明一些编程规范。

1.代码布局

（1）缩进。标准Python风格中每个缩进级别使用4个空格，不推荐使用Tab，禁止混用空格与Tab。

（2）行的最大长度。每行最大长度79，换行可以使用反斜杠，但建议使用圆括号。

（3）空白行。顶层函数和定义的类之间空两行，类中的方法定义之间空一行；函数内逻辑无关的代码段之间空一行，其他地方尽量不要空行。

（1）右括号前不要加空格。

（2）逗号、冒号、分号前不要加空格。

（3）函数的左括号前不要加空格，如fun（1）。

（4）序列的左括号前不要加空格，如list[2]。

（5）操作符左右各加一个空格，如a+b=c。

（6）不要将多条语句写在同一行。

（7）if、for、while语句中，即使执行语句只有一句，也必须另起一行。

（1）块注释。块注释跟随被注释的代码，缩进至与代码相同的级别。块注释使用“#”开头。

（2）行内注释。行内注释是与代码语句同行的注释。行内注释与代码至少由两个空格分隔，注释以“#”开头。

（3）文档字符串。文档字符串指的是为所有公共模块、函数、类以及方法编写的文档说明。文档字符串使用三引号包裹。

（1）不要使用字母“I”（L的小写）、“0”（大写0）、“I”（大写I）作为单字符变量名。

（2）模块名、包名应简短且全为小写。

（3）函数名应该小写，如果想提高可读性，可以用下画线分隔小写单词。

（4）类名首字母一般使用大写。

（5）常量通常采用全大写命名。

上一篇：python和java哪个更值得学？ 下一篇：Python的input()函数和print()函数