Python 注释

Python 中的注释是代码在程序执行过程中被解释器忽略的行。注释增强了代码的可读性，帮助程序员非常仔细地理解代码。

Python中的注释分为三种类型：

Python 中的注释

在示例中可以看出，Python 注释在程序执行过程中被解释器忽略。

# sample comment
name = "helloworld"
print(name)

输出：

helloworld

Python 单行注释以符号 (#) 开头，没有空格，一直持续到行尾。如果注释超过一行，则在下一行添加#并继续 Python 注释。事实证明，Python 的单行注释对于为变量、函数声明和表达式提供简短的解释非常有用。请参阅以下演示单行注释的代码片段：

# Print “Hello World!” to console
print("Hello World!")

输出：

Hello World!

Python 不提供多行注释的选项。但是，我们可以通过不同的方式编写多行注释。

使用多个 # 的多行注释

我们可以在Python中使用多个#标签来编写多行注释。每一行都将被视为单行注释。

# Python program to demonstrate
# multiline comments
print("Multiline comments")

输出：

Multiline comments

Python 会忽略未分配给变量的字符串文字，因此我们可以将这些字符串文字用作 Python 注释。

使用字符串文字的单行注释

'This will be ignored by Python'

使用字符串文字的多行注释

""" Python program to demonstrate
multiline comments"""
print("Multiline comments")

Python 文档字符串是带有三引号的字符串文字，出现在函数之后。它用于将已编写的文档与 Python 模块、函数、类和方法关联起来。它添加在函数、模块或类的正下方，以描述它们的功能。在 Python 中，文档字符串可以通过__doc__ 属性获得。

例子：

def multiply(a, b):
	"""Multiplies the value of a and b"""
	return a*b


# Print the docstring of multiply function
print(multiply.__doc__)

输出：

Multiplies the value of a and b

注释通常用于以下目的：