如何在Python中编写多行注释?

324 阅读3分钟

在计算机编程中,注释是程序员对程序代码的一种可读解释。这对每种编程语言都是一样的。因此,注释是任何程序的一个组成部分。

Python中的注释可以用来使代码更加可读。Python 也像其它语言一样支持多行注释。

Python 注释块

要在Python创建一个注释 ,在每一行前加一个#(octothorpe)。然后,在代码中使用注释块来防止在测试代码时执行。

大多数现有的编程语言都有跨越多个文本行的注释块的语法。例如,CJava。此外,大多数 Python IDE都支持一种机制,可以自动为你做带磅数符号的块注释。

程序员经常使用注释块,主要有两个目的。

  1. 解释代码
  2. 测试代码

如何在Python中注释代码

要在Python注释 代码,在每一个新的代码行写上 "#"(八角形) 。它告诉Python编译器忽略它的执行,转到下面一行。注释以#开头,Python编译器将忽略其执行。

# Use "#" to comment in Python code
print("Comment in Python")

在上面的例子中,我们用#号对代码进行了注释。只对单行代码有效,对多行代码无效。

当你把注释放在与语句相同的行上时,你就会有一个内联注释。

让我们使用另一个例子。

# Use * for multiplication of a number 
print(3 * 7)

输出

21

如果你把注释放在行尾,那么Python解释器就会执行注释之前的内容,忽略注释之后的内容。

Python多行注释

Python没有任何 内置的机制来写多行注释。要在Python中写多行注释,要在每一行前加一个 #来阻止注释。这意味着写连续的单行注释。每一行都连续用#号开始,就可以实现多行注释。

如果你用Java、C或C++工作,你可以写多行代码。

/*
This is a block comment.
which you can write for multiple lines
*/

但在Python中你不能这样做。

连续的单行注释

要在Python中对多行代码进行注释,可以使用#的连续单行注释。这个**"#"被称为八角形**。不幸的是,Python不支持适当的多行注释,因为注释多行代码需要更多的努力。

# Use * for multiplication of a number
# The * is a multiplication operator in Python
# To print the value, use the print() function
print(3 * 7)

输出

21

所以,要添加一个多行注释,可以在每一行插入一个**#**。

使用多行字符串作为注释

在 Python 中创建多行注释的另一种方法是使用多行字符串docstrings。尽管它有类似的效果,但这是用于文档字符串 ,而不是块状注释。如果你是临时注释事物,作为一种临时措施是可以接受的。

Python 提供了两种文档串:单行文档串和多行文档串。我们将使用多行 docstrings 来创建一个块状注释。

"""
Use * for multiplication of a number
The * is a multiplication operator in Python
To print the value, use the print() function
"""
print(3 * 7)

输出

21

Python 中的单行文档串

一个单行的文档串适合于一行。Python 中的单行文档串以三倍引号 ("") 开始,也以三倍引号 ("") 结束。

""" Use * for multiplication of a number """
print(3 * 7)

输出

21

正如你所看到的,我们使用了三引号的字符串来创建类似于 Python 中多行注释的东西。你需要确保正确缩进第一个**""";否则,你会得到一个语法错误。

保持你的注释清晰、简明、有解释力,这一直被认为是一个很好的做法。

注释的最终目的是为你和其他与该项目合作的开发者节省时间和精力。

Python注释块教程就到此为止。