数据结构
网络
关系数据库管理系统
操作系统
Java
MS Excel
iOS
HTML
CSS
Android
Python
C 编程
C++
C#
MongoDB
MySQL
Javascript
PHP
物理学
化学
生物学
数学
英语
经济学
心理学
社会学
时尚研究
法律研究什么是 PEP8？
在本文中，我们将解释 PEP8 及其在 Python 中的用途。此外，我们还将了解其在编码过程中的优势。
什么是 PEP8？
PEP 是 Python 企业提案（Python Enterprise Proposal）的缩写。编写具有良好逻辑的代码是编程的关键方面，但许多其他重要因素也会影响代码的质量。开发人员的编码风格使代码更可靠，每个开发人员都应该记住，Python 严格遵循字符串的顺序和格式。
良好的编码风格使代码更具可读性。代码对最终用户来说更简单。
PEP 8 是一份包含各种编写可读 Python 代码指南的文档。PEP 8 讨论了作为开发人员如何构建优美的代码。它于 2001 年由 Guido van Rossum、Barry Warsaw 和 Nick Coghlan 正式编写。PEP 的主要目标是提高代码的可读性和一致性。
PEP 8 已发展成为大多数 Python 项目遵循的风格指南；它支持非常易读且视觉上吸引人的代码风格。每个 Python 程序员都应该在某个时候阅读它；
以下是一些关键要点供您参考。
缩进
在 Python 中，与其他编程语言不同，缩进用于定义代码块。代码行的级别由缩进决定，缩进是 Python 编程语言的重要特性。通常，我们使用 4 个空格进行缩进。
四空格规则并非总是必需的，并且可以忽略续行。
示例
def functionName(first_variable, second_variable, third_variable, fourth_variable): # giving 4 spaces for indentation print(first_variable)
使用文档字符串
在 Python 中，您可以使用单行和多行文档字符串。另一方面，单行注释适合在一行上；在这两种情况下都使用三引号。这些用于定义特定程序或特定函数。
示例
def tutorialspoint(): """It is an example for single line docstring""" """It is an example for multiline comment"""
行应换行，使其不超过 79 个字符
Python 标准库比较保守，要求行限制为 79 个字符。可以使用括号、方括号和大括号来换行。它们应该优先于反斜杠使用。
示例
with open('/path/from/where/you/want/to/read/file') as fileOne, \ open('/path/where/you/want/the/file/to/be/written', 'w') as fileTwo: file_two.write(file_one.read())
命名约定
为了使程序更简单易读，应遵循一些命名标准。同时，Python 的命名约定有点令人困惑，但这里有一些可以轻松遵循的约定。
根据一项总体原则，对用户可见的 API 公共元素的名称应遵循表示用法而非实现的约定。
| 单个小写字母 | e =2 |
| 单个大写字母 | E = 2 |
| 小写 | num = 5 |
| 小写带下划线 | input_number = 5 |
| 大写 | NUM = 2 |
| 大写带下划线 | INPUT_NUMBER = 5 |
| 大写单词/ 驼峰式命名法 | InputNumber = 10 |
注意
当使用 CapWords 中的缩写时，请确保将缩写中的所有字母都大写。因此，HTTPServerError 比 HttpServerError 更可取。
Python 中的命名约定
下表显示了 Python 中一些最常见的命名风格 -
| 类型 | 命名约定 | 示例 |
|---|---|---|
| 函数 | 可以使用小写单词或用下划线分隔单词。 | demofunction, demo_function |
| 变量 | 为了提高可读性，我们可以使用小写字母、单词或分隔单词。 | n, num, input_num |
| 类 | 类名的第一个字母应大写或使用驼峰式命名法。不应使用下划线分隔单词。 | DemoClass, Model, Tutorialspoint |
| 方法 | 为了提高可读性，我们可以使用小写字母、单词或分隔单词。 | demo_method, methodname |
| 常量 | 它可以是简短的、大写字母、单词或分隔单词 | DEMOCONSTANT, CONSTANT, DEMO_CONSTANT |
| 模块 | 它可以是小写字母、单词或分隔单词 | Module_name.py, module.py |
| 包 | 它可以是小写字母、单词或分隔单词。不应使用下划线作为分隔单词。 | package, demopackage |
空行
通过使用空行可以提高 Python 代码的可读性。当多行代码组合在一起时，代码变得难以阅读。我们可以通过使用大量垂直空行来消除它，但读者可能需要比必要时滚动更多。要添加垂直空白，请按照以下步骤操作。
顶级函数和类使用两行 - 在它们周围添加额外的垂直空间以使其更具可读性。
class MyFirstClass: pass class MySecondClass: pass def main_function(): return None
类内使用单行空行 - 类中定义的函数彼此相关。
class MyFirstClass: def first_method(self): return None def second_method(self): return None
在函数内使用空行 - 有时我们需要创建一个复杂的函数，其中包含在 return 语句之前的许多步骤。因此，我们可以在每个步骤之间插入一个空行。
注释
注释是任何编程语言的重要组成部分。这些是描述代码最有效的方法。当我们使用适当的注释记录代码时，任何人都可以理解它。但请记住以下几点。
以大写字母开头并写出整个句子。
如果代码发生更改，请更新注释。
注释和文档字符串的长度限制为 72 个字符。
块注释
块注释是用于一小段代码的极佳解决方案。此类注释在编写多行代码以实现单个操作（例如循环迭代）时很有用。它们帮助我们理解代码的目的。
块注释应缩进到同一级别。
每行开头使用#和一个空格。
使用单个#分隔每一行。
示例
# Assigning the value of name (Block Line comment) name = "TutorialsPoint"
内联注释
内联注释用于代码中描述代码一部分中的单个语句。我们可以轻松地了解为什么开发了该特定代码行。PEP 8 中指定了内联注释的以下限制。
以和一个空格开头。
谨慎使用内联注释
我们应该将内联注释与它们引用的语句放在同一行上分隔开。
name = "TutorialsPoint" # Assigning the value of name (InLine comment)
结论
在本文中，我们了解了什么是 Pep8 以及如何使用各种方法编写高质量代码。
2K+ 次查看
