原文:Python Multiline Comment – How to Comment Out Multiple Lines in Python,作者:Kolade Chris

注释是每种编程语言不可或缺的一部分。通过注释,你可以更好地了解自己的代码,使其更具有可读性,并可以帮助团队成员了解其工作原理。

注释会被编译器和解释器所忽略,所以它们不会运行。

除了使你的代码更具可读性外,注释还可以在你调试时提供帮助——如果你有两行代码,你可以注释掉一行,让它不运行。

就像其他编程语言一样,Python 支持注释。

问题是,Python 没有内置的多行注释的机制。

所以,在这篇文章中,我将不仅仅告诉你如何在 Python 中进行单行注释,我还将告诉你进行多行注释的变通方法。

如何在 Python 中进行单行注释

要在 Python 中进行单行注释,需要在每一行前面加一个哈希(#)。

# print("Hello world")

print("Hello campers")

输出:

Hello campers

正如你所看到的,注释的那一行并没有在输出中打印出来。

如何在 Python 中进行多行注释

不像其它编程语言,如 JavaScript、Java 和 C++,它们使用 /*...*/ 来进行多行注释,在 Python 中没有内置的多行注释机制。

要在 Python 中注释多行,你可以在每一行前面加一个哈希(#)。

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")

输出:

Hello campers

使用这种方法,从技术上讲你是在做多个单行注释。

在 Python 中进行多行注释的真正解决方法是使用 docstrings

如果你在 Python 中使用 docstrings 来注释多行代码,这段代码将被忽略,只有 docstrings 以外的行才会运行。

"""
This is a multi-line comment with docstrings

print("Hello world")
print("Hello universe")
print("Hello everyone")
"""

print("Hello campers")

输出:

Hello campers

注意:有一点需要注意的是,在使用 doctsrings 进行注释时,缩进仍然很重要。如果你使用 4 个空格(或一个制表符)来缩进,你会得到一个缩进错误。

例如,这样就可以了:

def addNumbers(num1, num2, num3):
    """
    A function that returns the sum of
    3 numbers
    """
    return num1 + num2 + num3
print(addNumbers(2, 3, 4))

# Output: 9

但是这样行不通:

def addNumbers(num1, num2, num3):
"""
A function that returns the sum of
3 numbers
"""
    return num1 + num2 + num3
print(addNumbers(2, 3, 4))

所以你的IDE会抛出这样的错误:IndentationError: expected an indented block

总结

由于在 Python 中没有对多行注释的内置支持,这篇文章演示了如何使用 docstrings 作为一种变通方法。

不过,一般来说,你应该坚持使用普通的 Python 注释,使用哈希(#),即使你不得不对多行使用它。这是因为 docstrings 是用来编写文档的,而不是用来注释代码的。

如果你觉得这篇文章有帮助,请考虑与你的朋友和家人分享它。

谢谢你阅读本文。