Python 注释

Python注释是在Python源代码中添加的可供程序员阅读的解释或注释。它们的目的是使源代码更易于人们理解，并且被Python解释器忽略。注释提高了代码的可读性，并帮助程序员仔细理解代码。

就像大多数现代语言一样，Python支持单行（或行尾）和多行（块）注释。Python注释与PHP、BASH和Perl编程语言中的注释非常相似。

Python中有三种类型的注释：

• 单行注释
• 多行注释
• 文档字符串注释

单行注释

字符串文字内部的井号（#）开始一个注释。#后面的所有字符直到物理行的末尾都是注释的一部分，并且Python解释器会忽略它们。

示例

以下是Python中单行注释的示例：

# This is a single line comment in python

print ("Hello, World!")

这将产生以下结果 –

Hello, World!

在语句或表达式后面可以同行输入评论 –

name = "Madisetti" # This is again comment

多行注释

Python没有直接提供多行注释的方法。你可以按照以下方式注释多行代码。

# This is a comment.
# This is a comment, too.
# This is a comment, too.
# I said that already.

以下三重引号字符串在Python解释器中也被忽略，可以用作多行注释：

'''
This is a multiline
comment.
'''

示例

以下是展示多行注释用法的示例：

'''
This is a multiline
comment.
'''

print ("Hello, World!")

这会产生以下结果−

Hello, World!

文档字符串注释

Python文档字符串提供了一种方便的方式来为Python模块、函数、类和方法提供帮助文档。文档字符串可以通过__doc__属性访问。

def add(a, b):
    """Function to add the value of a and b"""
    return a+b

print(add.__doc__)

这将产生以下结果 –

Function to add the value of a and b