4. 使用适当的注释
不整洁(错误):
# Function to do something
def do_something(): pass
整洁(正确):
def do_something():
# TODO: Implement functionality or explain what the function does
pass
修复说明:
- 移除了不必要的或明显的注释,如果函数尚未实现,使用
TODO
注释来标记。
5. 遵守行长度约定
不整洁(错误):
def calculate_area(length, width): return length * width # 这行代码可能过长,超过了项目规定的最大行长度,比如80或120个字符。
整洁(正确):
def calculate_area(length, width):
# 下面的代码遵循了项目的最大行长度约定
return length * width
修复说明:
- 将单行代码分解为多行,遵守行长度限制。
6. 适当的错误处理
不整洁(错误):
try:
result = 10 / 0
except:
pass
整洁(正确):
try:
result = 10 / 0
except ZeroDivisionError as e:
logging.error("Attempted to divide by zero")
raise
修复说明:
- 修复了空的
except
块,现在适当地记录和重新抛出错误。