📜  Python中的多行注释

📅  最后修改于: 2022-05-13 01:54:53.779000             🧑  作者: Mango

Python中的多行注释

Python开发人员经常使用评论系统,因为如果不使用它,事情会变得非常混乱,非常快。注释是开发人员为使读者理解源代码而提供的有用信息。它解释了代码中使用的逻辑或其中的一部分。当您不再回答有关代码的问题时,注释通常有助于维护或增强您的代码。这些通常被引用为一种有用的编程约定,它不参与程序的输出,但提高了整个程序的可读性。

但是, Python中没有多行注释的概念。但可以通过以下方式实现。

Python中实现多行注释的方法

  • 连续单行注释
  • 使用多行字符串作为注释

连续单行注释

哈希字符(#) 用于在Python程序中注释行。注释不一定是解释代码的文本,也可以用来阻止Python执行代码。哈希字符应放在要注释的行之前。在Python中,连续的单行注释可以用作多行注释。

例子:

# Write Python3 code here
# Single line comment used
  
print("Python Comments")
  
# print("Mathematics")

输入和输出

在这里,前两行包含字符号 (#),解释器阻止这两行的执行。然后它会打印“Python Comments”,最后,它会阻止最后一行的执行。

使用多行字符串作为注释

Python多行注释是一段文本,包含在注释两端的分隔符(""")中。同样,分隔符(""")之间不应有空格。当注释文本不适合一行时,它们很有用;因此需要跨行。多行注释或段落可作为其他人阅读您的代码的文档。请参阅以下演示多行注释的代码片段:

例子:

# Write Python code here
  
""" Multi-line comment used
print("Python Comments") """
  
print("Mathematics")

输入和输出

在上面的例子中,多行注释用于注释多行。第一行是单行注释。第二行和第三行可以使用三引号( """ """" )进行注释。这会阻止上述代码的执行。最后,它会在输出中打印“数学”。

但是,如果这些多行注释直接放在函数或类签名之后,那么它们就会变成docstrings 。 Docstring 是Python的一个内置功能,用于将已编写的文档与Python模块、函数、类和方法关联起来。它被添加到函数、模块或类的正下方以描述它们的作用。在Python中,然后通过__doc__属性使文档字符串可用。

例子:

def multiply(a, b):
    """Multiplies the value of a and b"""
    return a*b
       
       
# Print the docstring of multiply function
print(multiply.__doc__)

输出:

Multiplies the value of a and b