在Python中,你可以使用注释来为代码添加说明性的文本。注释不会被解释器执行,而是用于提供关于代码的说明、描述或者标记。Python支持两种类型的注释:单行注释和多行注释。

1. 单行注释

单行注释以 # 符号开头,后面的内容都被视为注释。
# 这是一个单行注释
x = 5  # 这是另一个单行注释

2. 多行注释

多行注释使用三个单引号 ''' 或三个双引号 """ 包裹,可以跨越多行。
'''
这是一个多行注释
它可以跨越多行
'''

或者使用双引号:
"""
这也是一个多行注释
可以使用单引号或双引号
"""

多行注释通常用于函数、类、模块的文档字符串(docstring),用于说明函数或模块的作用、参数、返回值等信息。
def example_function(x):
    """
    这是一个示例函数的文档字符串
    
    参数:
    x (int): 函数的参数
    
    返回:
    int: 函数的返回值
    """
    return x * 2

在实际编码中,良好的注释是一个良好编程实践的一部分,可以帮助他人更好地理解你的代码,也有助于你自己在日后回顾代码时更容易理解。


转载请注明出处:http://www.pingtaimeng.com/article/detail/196/Python3