Python 代码示例：求列表平均数并附带详细注释

# 求一个列表的平均数
def average(numbers):
    '''
    计算一个列表的平均数
    :param numbers: 包含数字的列表
    :return: 平均数
    '''
    if len(numbers) == 0:
        return None  # 如果列表为空，返回None
    return sum(numbers) / len(numbers)  # 返回列表数字的总和除以数字的个数

# 测试代码
numbers = [1, 2, 3, 4, 5]
result = average(numbers)
print('The average is:', result)

在上述代码中，注释的作用如下：

• 第一行注释（# 求一个列表的平均数）简单地描述了代码的功能。
• 函数定义（def average(numbers):）下面的注释（''' 计算一个列表的平均数... '''）是函数的文档字符串，它描述了函数的参数和返回值。
• 第6行注释（if len(numbers) == 0: return None）描述了如果列表为空时返回的结果。
• 第7行注释（return sum(numbers) / len(numbers)）解释了函数的返回值，即列表中数字的总和除以数字的个数。
• 最后几行代码展示了如何使用这个函数，并打印出结果。