Python中的注释用于对代码进行解释说明,增强代码可读性,且注释内容不会被解释器执行。主要有以下几种注释方式:

单行注释

  • # 开头,用于对单行代码进行解释。例如:# 计算两个数的和
  • 可放在代码行末尾,对该行代码进行补充说明。例如:a = 1 + 2 # 将1和2相加,结果赋给a

多行注释

  • 用三个单引号 ''' 或三个双引号 """ 括起来,可用于对函数、类等进行详细说明,也能注释掉一大段代码。例如:
'''
这是一个多行注释
用于说明函数的功能、参数、返回值等
'''
def add(a, b):
    return a + b
  • 也可使用多个单行注释来实现多行注释的效果,但不如使用三个单引号或双引号方便。例如:
# 这是第一行注释
# 这是第二行注释
# 这是第三行注释

特殊注释

  • 文档字符串注释:在函数、类或模块的开头,使用三个双引号括起来,用于生成文档。解释器会将其作为对象的 __doc__ 属性保存,可通过 help() 函数查看。例如:
def add(a, b):
    """
    这个函数用于计算两个数的和

    参数:
    a: 第一个数
    b: 第二个数

    返回值:
    两个数的和
    """
    return a + b
  • 类型注释:Python 3.5 引入了类型提示语法,可在变量和函数参数、返回值中添加类型注释,提高代码可读性和可维护性。例如:
def add(a: int, b: int) -> int:
    return a + b