pycharm 使用文档注释 定义变量类型

pycharm 使用文档注释 定义参数类型

# 原理：
  pycharm有一个会帮助检查参数类型的功能
  有时它不能识别我们想要给参数传递的类型，而导致不能给出正确的提示
  此时在确定自己已传参数类型时，可以使用文档注释法
  告诉编辑器，该变量是哪个类的对象 是什么类型


# eg:
from pymongo import MongoClient
from pymongo.collection import Collection

client=MongoClient('mongodb://root:123@localhost:27017/')

db=client['db2']  # 等同于：client.db1


### 自定义方法：在变量后的 注释部分写 # type:类名
table_user=db['userinfo'] # type:Collection  # 等同于：db.user
  
  # 为什么后面跟 '# type:Collection'?
    通过 '# type:Collection'，可以告诉编辑器，该变量是哪个类的对象 是什么类型
    方便给出正确的方法提示

    因为python是解释器语言，变量table_user的类型有可能随时在变
    而pycharm编辑器有时候不一定完全能够识别 目前该变量的类型
    那么pycharm编辑器，在敲该变量时，就不一定能 '.' 点出该类型的方法
    
### pycharm编辑器--其他方法
  1.将光标置于需要指定的参数位置上，按下Alt+Enter
    选择：Insert documentation string stub.或者 
    Specify type for reference in docstring
    
    此时你的函数注释文档中就会有一句：
    type yourparametername: object 
      # yourparametername = 你需要指定的参数名，object = 你需要指定的参数类型，
        
    此时把object改成你需要的参数类型就可以了

  2.打开 Settings / Preferences 或 Settings /Build,Execution,
    Deployment 对话框的Python Debugger 页面中 
    Insert documentation string stu 调试函数
    再次插入文档参数类型
    有关在调试会话期间获得的参数和返回值的信息将用于预先填充文档字符串中的类型注释。