Python 多行注释

多行注释用于在编程语言中将注释写成两行或更多行。它主要用于详细解释、禁用程序中不希望添加但想展示给其他程序员的大段代码，有时也用于提高代码的可读性。尽管 Python 没有提供专门的多行注释语法，但有几种方法可以在 Python 中实现多行注释。

Python 中多行注释的类型

Python 中有多种方法可以创建多行注释。其中一些如下：

• # 符号
• 三引号 (''' 或 """)
• 反斜杠 (\) 方法
• 文档字符串

让我们在以下部分讨论这些多行注释的方法。

# 符号

# 符号用于编写单行 注释。但我们可以通过在单独的行上连续使用 # 符号来创建多行注释。这是编写多行注释的一种简单有效的方法。

语法

让我们看一个使用 # 符号编写多行注释的示例。

输出

 
Welcome to tpointtech   

说明

在此，前三行包含一个哈希字符 (#)，解释器会忽略这些行，并阻止这三行的执行。然后它会打印“Welcome to tpointtech”，最后，它会阻止 # 行的执行。

三引号 (''' 或 """)

在 Python 中编写多行字符串的另一种方法是使用代码中的三重单引号或三重双引号。虽然 Python 实际上将其视为字符串字面量而非注释，但我们可以使用它们来编写多行注释，因为没有值被赋给变量。

语法

现在我们将看一个示例，展示在编写多行注释时使用三引号。

输出

 
Hello Programmers. This is an example for Triple Single and triple Double quotes   

说明

如果在三引号字符串中没有赋值给变量，Python 会忽略这些字符串，因此它们可以用作注释。

注意：三引号的主要用途是文档字符串（docstrings）。

反斜杠 (\) 方法

在 Python 中，反斜杠方法是一种用于注释掉多行的技术。尽管开发人员不常使用它，因为他们认为这是一种非传统的方法。在此方法中，我们显式地使用 (\) 将一个语句跨越多行，从而有效地阻止 Python 执行代码。

注意：反斜杠用于确保语句将继续到下一行。如果在多行的末尾指定反斜杠而没有形成一个有效语句，Python 会忽略它，因为它将其视为一个不完整的语句。

语法

现在我们将看到一个使用反斜杠编写多行注释的示例。

输出

 
Welcome to tpointtech!  

说明

在此，在每行注释的末尾使用反斜杠来表示它是一个多行注释。

文档字符串

文档字符串（docstring）被定义为用于指定任何特殊模块、函数、类或方法的字符串。它不像普通注释，因为 Python 会将文档字符串存储为元数据，并且可以使用 \_\_doc\_\_ 属性进行访问。

语法

让我们看一个例子来理解如何在 Python 中编写文档字符串。

输出

 
---> THIS IS A SAMPLE DOCSTRING <---
This Function will print a statement

说明

在这里，我们定义了一个名为 welcome() 的函数。在此函数内部，我们添加了一个多行字符串，称为文档字符串。此文档字符串解释了函数的工作原理。然后我们添加了一个打印语句。在函数外部，我们使用 \_\_doc\_\_ 属性来返回函数的文档字符串并将其打印出来。

Python 中文档字符串和多行注释的区别

用于调试的多行注释

调试是另一个重要功能，因此开发人员在程序中使用多行注释。使用注释，您可以暂时禁用任何代码。它们也不占用内存。

示例

多行注释的优点

以下是在 Python 程序中使用多行注释的一些优点：

• 提高代码可读性
• 提供简要文档
• 增强协作
• 向其他程序员提供模块说明
• 有助于调试

注意事项

以下是您在使用 Python 多行注释时需要记住的关键点。

• 多行注释可用于暂时禁用代码。
• 使用 # 符号进行注释（不占用内存）对于调试更好。
• 不应将三引号字符串用于调试。

结论

Python 中的多行注释是提高代码可读性和文档性的重要工具。尽管 Python 没有提供直接的语法来实现多行注释。但您可以使用 # 符号、三引号（''' 或 """)、反斜杠方法或文档字符串在程序中添加多行注释。本教程简要涵盖了实现它们的全部细节和步骤。正确理解和应用这些方法可以使您的 Python 代码更具可读性、可维护性和专业性。

Python 多行注释常见问题解答

1) 什么是 Python 中的多行注释？

多行注释用于在多行中解释代码块或逻辑，从而提高代码的可读性和文档性。

2) 如何在 Python 中编写多行注释？

Python 没有像其他一些语言那样的特殊多行注释语法。您可以：

1. 使用多个单行注释（#）
2. 使用三引号（''' 或 """）进行文档记录或代码块。

3) 编写多行注释最推荐的方式是什么？

使用多个 # 行是实际注释的推荐方法。

示例

4) 多行注释会影响代码性能吗？

不会。Python 解释器在执行期间会忽略 # 注释和三引号字符串（未赋值给变量）。

5) 我可以在函数或循环中使用多行注释吗？

是的，您可以将多行注释放在代码的任何位置来解释功能（在函数、循环或条件语句中）。