Python：文档注释、类型标注和注释宏# type:

目录

• 1、增加文档注释
• 2、增加类型标注
• 3、增加注释宏

看一段简单的代码

def add(x, y):
    return x + y

如下代码调用函数，可以正常执行

print(add(1, 2)) # 3
print(add('1', '2')) # 12

1、增加文档注释

def add(x, y):
    """
    sum x and y
    :param x: int
    :param y: int
    :return: int
    """
    return x + y

鼠标放到函数调用处，没有提示

2、增加类型标注

def add(x: int, y: int) -> int:
    return x + y

IDE中的代码会出现异常提示：Expected type ‘int’, got ‘str’ instead，不过代码是可以正常运行的

3、增加注释宏

def add(x, y):
    # type: (int, int) -> int
    return x + y

IDE表现结果和类型标注一样，都会有异常提示

参考：
【Python】类型注解 ③ ( 使用 # type: 类型 注释方式设置类型注解 | 类型注解是提示性而非强制性 )

python注释宏 # type