Python自学教程2-大牛们怎么写注释

1. 注释的重要性

在编写Python代码时，注释的作用不可忽视。注释可以提高代码的可读性，便于别人理解你的代码，并且方便自己日后阅读和修改自己的代码。

一些标准的注释格式包括单行注释和多行注释。单行注释是用#符号开头，在一行中注释单个语句或者函数，多行注释是用三个双引号或者三个单引号包裹，注释一段代码的功能或者一个函数的说明。

2. 大牛们写注释的风格

2.1 Guido van Rossum

Guido van Rossum是Python的创始人。在他的代码中，注释风格比较简洁明了，主要是单行注释。他认为注释应该简短明了，对于复杂的代码，应该通过代码的结构和命名来提高可读性。

def foo(a, b):

    # 这里计算a和b的平均值
    return (a+b)/2

2.2 Brandon Rhodes

Brandon Rhodes是Python社区里著名的大牛，他的注释风格更加详细精细。在他的代码中，注释通常都是多行注释，对于代码中每个函数和类，都会写上详细的说明，包括函数的作用、参数、返回值等。他认为好的注释应该像好的故事一样，能够让读者产生共鸣。

def fibonacci(n):

    """
    Return the `n` th Fibonacci number, for positive `n`.
    
    Parameters
    ----------
    n : int
        The index of the Fibonacci number to compute.  Non-positive
        inputs are treated by assuming that only the first two
        Fibonacci numbers are 0 and 1, and that all others follow
        from their sum.
    Returns
    -------
    int
        The `n` th Fibonacci number.
    """
    if n <= 0:
        return 0
    a, b = 0, 1
    for _ in range(n-1):
        a, b = b, a+b
    return b

2.3 Raymond Hettinger

Raymond Hettinger是Python核心开发者之一，他的注释风格更加灵活。他主张写出自己的代码风格，并且在注释中保持一定的幽默感，把注释作为一个人际交往的工具。他认为注释的作用不仅仅是解释代码，更是展现作者的个性。

def prime_factors(n):

    """
    Return the prime factors of n, sorted in ascending order.
    Example:
    >>> prime_factors(12)
    [2, 2, 3]
    """
    i = 2
    factors = []
    while i*i <= n:
        if n % i:
            i += 1
        else:
            n //= i
            factors.append(i)
    if n > 1:
        factors.append(n)
    return factors

3. 备注

注释不应该滥用，只有在必要的时候才需要添加注释。对于代码的结构和命名，也应该注重可读性。好的代码应该能够自解释。

在Python中，注释的标准格式可以参考PEP 8，这是Python社区的一份代码风格指南。在实际编写中，我们可以根据自己的习惯和不同的情境，选择不同的注释风格。重要的是，注释应该为读者提供足够的信息，帮助他们理解代码的逻辑。