我们如何在Python中创建多行注释？

注释是出现在代码中间的信息片段，允许开发人员向其他开发人员解释他的工作。它们使代码更具可读性，因此更易于调试。

内联注释

内联注释是单行注释，与语句位于同一行。它们是通过在文本前放置一个“#”符号来创建的。

句法：

# This is a single line comment

例子：

Python3

def my_fun():
   
    # prints Geeksforgeeks on the console
    print("GeeksforGeeks")
 
# function call
my_fun()

输出：

GeeksforGeeks

注意：虽然不是必需的，但根据Python ，# 符号和注释文本之间应该有一个空格，并且注释和语句之间应该至少有 2 个空格。

阻止评论

Python中的块注释通常指的是它们后面的代码，并且旨在与该代码处于同一级别。每行块注释都以“#”符号开头。

句法：

# This is a block comment 
# Each line of a block comment is intended to the same level

例子：

Python3

def my_fun(i):
   
    # prints GFG on the console until i
    # is greater than zero dercrements i
    # by one on each iteration
    while i > 0:
        print("GFG")
        i = i-1
 
 
# calling my_fun
# it will print GFG 5 times on the console
my_fun(5)

输出：

GFG
GFG
GFG
GFG
GFG

文档字符串

文档字符串是作为模块、函数、类或方法定义中的第一条语句出现的字符串字面量。它们解释了这段代码可以实现什么，但不应包含有关代码背后逻辑的信息。文档字符串成为该对象的 __doc__ 特殊属性，这使得它们可以作为运行时对象属性访问。它们可以写成两种方式：

1. 一行文档字符串：

句法：

"""This is a one-line docstring."""

或者

'''This is one-line docstring.'''

例子：

Python3

def my_fun():
    """Greets the user."""
    print("Hello Geek!")
 
     
# function call
my_fun()
 
# help function on my_fun
help(my_fun)

输出：

Hello Geek!
Help on function my_fun in module __main__:

my_fun()
    Greets the user.

请注意，对于单行文档字符串，右引号与左引号位于同一行。

2.多行文档字符串：

句法：

"""This is a multi-line docstring.

The first line of a multi-line doscstring consist of a summary.
It is followed by one or more elaborate description.
"""

例子：

Python3

def my_fun(user):
    """Greets the user
 
    Keyword arguments:
    user -- name of user
    """
    print("Hello", user+"!")
 
# function call
my_fun("Geek")
 
# help function on my_fun
help(my_fun)

输出：

Hello Geek!
Help on function my_fun in module __main__:

my_fun(user)
    Greets the user
    
    Keyword arguments:
    user -- name of user

结束引号必须单独在一行，而开始引号可以与摘要行在同一行。

编写文档字符串的一些最佳实践：

• 为了一致性起见，使用三重双引号。
• 文档字符串前后没有多余的空格。
• 与注释不同，它应该以句点结尾。