Python 中的注释是什么？

解释器在程序运行时忽略的 Python 代码行称为注释。注释是程序中未执行的一行文本。Python 代码可以用注释来解释。通过添加注释可以使代码更易于阅读。

Python 中的注释类型

Python 编程语言中有三种类型的注释，它们是：

1. 单行评论
2. Python 中的多行注释
3. Docstring讨论

1. Python 中的单行注释

• Python 中的单行注释以主题标签 （#） 开头，一直持续到该行的末尾。
• 如果注释是多行，请在下一行放置一个主题标签，然后继续 Python 注释。
• 事实证明，Python 中的单行注释有助于为 Python 中的变量、Python 中的函数声明和表达式提供快速解释。

Python 中的单行注释示例

        # This is a single line comment in python
print ("Hello, World!") 

Python 编译器中的此 Python 代码将“Hello， World！”输出到控制台，并包含由“#”符号表示的单行注释，该注释用于向代码添加解释或注释，但在执行代码时被忽略。

输出

Hello, World!

2. Python 中的多行注释

Python 不支持多行注释。但是，还有其他方法可以编写多行注释。

在多行注释中使用多个主题标签 （#）

在 Python 中，可以使用多个主题标签 （#） 来构造多行注释。每一行都将被视为单独的评论。

使用 Python 的字符串文字

• Python 字符串文字，可以与三引号（''' 或 “”“）一起使用，是实现此目的的另一种方法。
• 对于多行字符串，通常使用这些三引号。但是，如果我们不将其分配给任何变量或函数，我们可以将其用作注释。
• 如果字符串未分配给任何 Python 函数或 Python 变量，解释器将忽略它。

Python 中的多行注释示例

        '''
This is a multiline
comment.
'''
print ("Hello, World!")

Python 编辑器中的此 Python 代码包含一个用三重单引号括起来的多行注释，并充当解释或文档块，同时在执行过程中被忽略。然后，消息“Hello， World！”将打印到控制台。

输出

Hello, World!

3. Python 中的文档字符串

• Docstrings 是 Python 的内置功能，允许对模块、方法、函数、对象和类进行注释。
• 三个引号（''' 或 “”“）用于在 Python 中定义模块、函数、方法等之后的第一行中写入它们。
• 如果不在第一行中使用它，解释器将无法将其识别为文档字符串。
• 此外，还可以使用 __doc__ 属性来检索文档字符串。

Python 中的 Docstring 示例

        def greet(name):
    """Greets the specified person."""
    print(f"Hello, {name}!")
greet("Ram")

此代码中的 greet 函数只有一个参数 name。使用 f 字符串，greet 函数在终端上打印自定义的问候语。

输出

Hello, Ram!

Python 注释的使用

使代码更易于理解：

• 编码注释将使将来更容易引用。
• 此外，其他开发人员将更容易掌握代码。

使用注释帮助调试：

• 如果在执行程序时遇到错误，则无需消除导致错误的代码行，而是可以对其进行注释。

在 Python 中使用注释的优点

Python 注释提供了几个优点。它们的主要优点是：

• 代码的可读性
• 对项目代码或元数据的说明
• 停止代码运行
• 整合资源

。