Python 注释

Python 注释是程序员在编写代码期间使用的一种文本。注释在代码中并不起作用，但可以提供关键的信息，例如代码是如何工作的、变量的含义、函数的目的等等。Python 中有两种类型的注释：单行注释和多行注释。

单行注释

Python 中使用井号（#）来表示单行注释。井号之后的所有内容都会被忽略，直到行尾为止。

下面是一个例子：

# 这是一个单行注释
print("Hello, World!")  # 这也是一个单行注释

多行注释

Python 中没有专门的多行注释语法，但可以使用字符串来模拟多行注释。在字符串前后添加三个单引号或三个双引号来创建一个多行字符串。

下面是一个例子：

'''
这是一个多行注释。
它可以包含多行内容。
'''

print("Hello, World!")

在上面的例子中，三个单引号之间的所有内容都被视为多行注释，而 print("Hello, World!") 则是实际执行的代码。

文档字符串

Python 中的模块、类和函数都可以有文档字符串。它们可以被视为多行注释的一种形式，并被解释器自动提取作为相关对象的文档。

下面是一个例子：

def greet(name):
    """
    这个函数用于向人们问候。
    
    参数:
    name -- 一个字符串。
    
    返回值:
    一个字符串，包含问候语和给定的名字。
    """
    return "Hello, " + name + "!"

print(greet("John"))

在上面的例子中，greet 函数的文档字符串被用来说明该函数的参数和返回值。可以使用 help 函数来查看对象的文档字符串：

help(greet)

输出结果：

Help on function greet in module __main__:

greet(name)
    这个函数用于向人们问候。
    
    参数:
    name -- 一个字符串。
    
    返回值:
    一个字符串，包含问候语和给定的名字。

总结

Python 注释是程序员在编写代码期间使用的一种文本。单行注释使用井号（#）表示，多行注释可以使用字符串来模拟。文档字符串可以作为多行注释的一种形式，被解释器自动提取作为相关对象的文档。