如何在 Python 中注释掉一段代码

在使用 Python 时，注释是最有用的工具之一。它们在不影响执行的情况下，引导我们理解代码块背后的逻辑、决策和目的。注释有助于提高代码的可读性和可维护性，并促进团队环境中的协作。

本教程将探讨在 Python 中注释多行代码的两种有效方法，确保您的代码有良好的文档记录且易于理解。

为什么 Python 中的块注释很重要？

在学习 Python 的过程中，注释往往是您首先接触到的概念之一。它们为某段代码的意图提供有用的上下文，并阐明脚本为何会以特定方式运行。始终在脚本中使用注释有许多重要理由。以下是其中四点：

• 文档化：注释是一种文档形式，用于解释函数、类或代码块的目的。对于逻辑不那么直观的复杂算法，这尤为有用。
• 可读性：注释完善的代码更易阅读和理解。这在您或他人隔一段时间后回看代码时尤为重要。
• 调试：临时注释掉部分代码是隔离并定位错误的常见做法。
• 协作：在团队环境中，注释使代码更易共享和理解，从而促进更顺畅的协作与代码评审。

在 Python 中使用单行块注释

在深入了解如何注释多行之前，我们先从单行注释的基础开始。在 Python 中，单行注释以井号（#）开头，解释器会忽略该行之后的所有内容。要创建单行注释，请按以下说明操作：

1. 放置位置：将 # 符号放在行首，或放在同一行代码之后。注释可以放在所描述代码的上方、同一行代码右侧，或单独成行。
2. 内容：在 # 符号之后编写您的注释。它可以是对该行代码的解释、供日后参考的备注，或与代码相关的任何有用信息。

# This is a single-line comment explaining the next line of code
print("Hello, world!")  # This prints a message to the console技术支持

方法一：使用多个单行 # 进行注释

在 Python 中最直接的注释方式是使用 # 符号，它会注释掉该行中其后的所有内容。虽然 Python 没有专门的块注释语法，但您可以对每一行分别使用多个 # 来实现块注释。您只需执行以下步骤：

1. 确定代码块：首先确定您希望注释掉的代码块。它可以是一个函数、一个循环，或您想禁用或解释的任何代码片段。
2. 逐行注释：在希望注释掉的每一行开头添加一个 # 符号。这会告诉 Python 解释器在执行时忽略这些行。

请看下面的示例：

# Example of commenting out multiple lines individually 
# print("Hello, world")
# print("What are you up to?")

print("Just floating in space. What was the question?")技术支持

Python 块注释方法二：使用三引号字符串字面量

另一种注释多行代码的方法是使用三引号字符串字面量（''' ''' 或 """ """）。虽然这并非官方的块注释，但这些字符串字面量常被用作多行注释或文档字符串（docstring）。要使用三引号字符串，只需在要注释的代码块前后分别放置 ''' 或 """，如下所示：

'''
def example_function(name):
	print("Hello", name)
'''技术支持

三引号字符串字面量最常用于为Python 函数编写文档。例如：

# Create hello() function
def hello(name):
	'''
	This function takes as input a name, 
	and returns a salutation to the name in the form of "Hello name"
	'''
	# Print the output 
	print("Hello", name)

hello("John")技术支持

这些三引号字符串字面量被称为 docstring——您可以在我们的docstring 教程中了解更多。