提升代码可读性的十八条建议4

10. 避免使用魔法数值

不整洁（错误）:

timeout = 120 # 这是什么？为什么是120？ 

整洁（正确）:

DEFAULT_TIMEOUT_SECONDS = 120 timeout = DEFAULT_TIMEOUT_SECONDS 

修复说明:

11. 避免过长的函数

不整洁（错误）:

def process_data(data): 
    # 多达几十行的代码 
    pass 

整洁（正确）:

def process_data(data):
    preprocess_data(data)
    calculate_statistics(data)
    postprocess_data(data)

def preprocess_data(data):
    # 预处理逻辑
    pass

def calculate_statistics(data):
    # 计算统计数据
    pass

def postprocess_data(data):
    # 后处理逻辑
    pass

修复说明:

当然，我们可以进一步探索如何保持代码整洁、有序，并遵守编码风格和命名约定。以下是一些额外的建议：

12. 合理使用空行

合理地使用空行来分隔逻辑部分可以增强代码的可读性。

不整洁（错误）:

def complex_function():
    do_first_thing()
    do_second_thing()
    do_third_thing()
    # 这里缺少空行，使得不同的部分难以区分
    do_fourth_thing()

整洁（正确）:

def complex_function():
    do_first_thing()
    do_second_thing()

    do_third_thing()

    do_fourth_thing()

修复说明:

作者：兔老大RabbitMQ