### Python 命名规范 #### 变量命名 - 变量名通常使用小写字母，单词之间用下划线分隔，这种命名方式称为蛇形命名法（snake_case）。例如： ```python user_name = "John" age = 25 ``` - 对于常量，通常使用全大写字母，单词之间用下划线分隔。例如： ```python MAX_CONNECTIONS = 100 PI = 3.14159 ``` #### 函数命名 - 函数名同样使用蛇形命名法，应该具有描述性，能够清晰表达函数的功能。例如： ```python def calculate_average(numbers): return sum(numbers) / len(numbers) ``` #### 类命名 - 类名使用大驼峰命名法（PascalCase），即每个单词的首字母大写。例如： ```python class Person: def __init__(self, name, age): self.name = name self.age = age ``` #### 模块命名 - 模块名使用小写字母，尽量简洁且具有描述性。如果是多个单词，使用下划线分隔。例如： ```python # 模块名为 utils.py import utils ``` ### Python 编码规约 #### 代码缩进 - Python 使用缩进来表示代码块，通常使用 4 个空格作为缩进。例如： ```python if True: print("This is inside the if block") else: print("This is inside the else block") ``` #### 注释规范 - 单行注释以 `#` 开头，用于解释代码的功能或提供额外信息。例如： ```python # This is a single-line comment x = 10 ``` - 多行注释使用三引号 `'''` 或 `"""`，通常用于函数、类的文档字符串（docstring）。例如： ```python def add_numbers(a, b): """ This function takes two numbers as input and returns their sum. """ return a + b ``` #### 语句换行 - 如果一行代码过长，可以使用反斜杠 `\` 进行换行。例如： ```python result = 1 + 2 + 3 + \ 4 + 5 + 6 ``` - 也可以在括号内进行自然换行。例如： ```python numbers = [1, 2, 3, 4, 5, 6] ``` #### 避免不必要的括号 除非是用于实现行连接，否则不要在返回语句或条件语句中使用括号，不过在元组两边使用括号是可以的。例如： ```python # 不建议 if (x > 10): print("x is greater than 10") # 建议 if x > 10: print("x is greater than 10") ```