Python评论
Python中的注释是代码中在程序执行期间被解释器忽略的行。注释增强了代码的可读性,帮助程序员非常仔细地理解代码。 Python中有三种类型的注释——
- 单行注释
- 多行注释
- 文档字符串注释
示例: Python中的注释
Python3
# Python program to demonstrate comments
# sample comment
name = "geeksforgeeks"
print(name)
Python3
# Print “GeeksforGeeks !” to console
print("GeeksforGeeks")
Python3
# Python program to demonstrate
# multiline comments
print("Multiline comments")
Python3
'This will be ignored by Python'
Python3
""" Python program to demonstrate
multiline comments"""
print("Multiline comments")
Python3
def multiply(a, b):
"""Multiplies the value of a and b"""
return a*b
# Print the docstring of multiply function
print(multiply.__doc__)
输出:
geeksforgeeks
在上面的例子中,可以看出注释在程序执行过程中被解释器忽略了。
注释通常用于以下目的:
- 代码可读性
- 项目代码或元数据说明
- 阻止代码执行
- 包括资源
Python中的注释类型
Python中有三种主要的注释。他们是:
单行注释
Python单行注释以井号 (#) 开头,没有空格,一直持续到行尾。如果评论超过一行,则在下一行添加主题标签并继续评论。事实证明,Python 的单行注释对于为变量、函数声明和表达式提供简短的解释很有用。请参阅以下演示单行注释的代码片段:
例子:
Python3
# Print “GeeksforGeeks !” to console
print("GeeksforGeeks")
输出
GeeksforGeeks
多行注释
Python不提供多行注释选项。但是,我们可以通过不同的方式编写多行注释。
使用多个标签 (#)
我们可以使用多个主题标签 (#) 在Python中编写多行注释。每一行都将被视为单行注释。
示例:使用多个主题标签(#)的多行注释
Python3
# Python program to demonstrate
# multiline comments
print("Multiline comments")
输出
Multiline comments
使用字符串字面量
Python会忽略未分配给变量的字符串字面量,因此我们可以将这些字符串字面量用作注释。
示例 1:
Python3
'This will be ignored by Python'
在执行上述代码时,我们可以看到不会有任何输出,因此我们使用带有三引号(“””)的字符串作为多行注释。
示例 2:使用字符串字面量的多行注释
Python3
""" Python program to demonstrate
multiline comments"""
print("Multiline comments")
输出
Multiline comments
Python文档字符串
Python docstring是带有三引号的字符串字面量,出现在函数之后。 它用于将已编写的文档与Python模块、函数、类和方法相关联。它被添加到函数、模块或类的正下方以描述它们的作用。在Python中,然后通过 __doc__ 属性使文档字符串可用。
例子:
Python3
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