Pyhton中一些具有特别用处的注释

1. TODO注释

单行注释“#”号后使用TODO关键字

效果：
1）蓝色高亮显示注释；
2）并能通过Pycharm控制台中TODO下的Project窗口中快捷访问；

作用：
TODO注释可表示当前未完成，将来需要更新完善的代码。

比如：在搭建项目框架时，标识待完成的细节，等待框架搭建完成后再回来完成。

格式：# TODO:后跟注释说明，也可以添加开发人员的名字，表示将来待谁完善的地方

# TODO: 此处代码待日后完善 David

2. 类型注解

定义函数或者变量时，可以对函数参数、函数返回值和变量类型进行注解。

例：

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

a: int = 10
b: str = 'David'

使用: 类型对函数参数或变量类型进行注解；使用-> 类型对函数返回值类型进行注解。

这种注解方式对代码来说没有任何影响，Python解释器也不会因此而进行额外的校验。这么做的好处是：
1）别的程序员能够一眼看出参数或变量类型；
2）IDE能够通过该声明得知类型，从而提供更准确的代码提示、补全和语法检查；

补充：
可通过函数名.__annotations__获取对函数参数和返回值的注解。

print(add.__annotations__)
结果：
{'x': <class 'int'>, 'y': <class 'int'>, 'return': <class 'int'>}

3. type注释

通过# type:对数据类型进行注释说明。既可向IDE声明数据类型，也能让其他程序员一目了然。

b = a   # type: str

PS：向IDE声明数据类型，其将能提供更准确的代码提示等。