【网络教程】利用PyCharm给函数增加文档注释（参数说明，参数类型设置）

---

函数添加参数说明

• 更多免费分享请点击这里
• 定义完一个函数之后，直接在下一行连续输入三对引号（单引号/双引号）回车即可自动生成函数说明文档，然后自己补充/填写完成即可

def test(param1,param2,param3):
    '''
    这里写函数说明
    :param param1: 这里写参数说明
    :param param2: 这里写参数说明
    :param param3: 这里写参数说明
    :return: 这里写参数说明
    '''
    pass

---

函数添加参数类型说明

• 在前面给函数添加参数说明的基础上直接添加对应参数的:type字段即可添加对应的函数参数类型说明

def test(param1,param2,param3):
    '''
    这里写函数说明
    :param param1:这里写参数说明
    :param param2:这里写参数说明
    :param param3:这里写参数说明
    :type param1:str
    :type param2:int
    :type param3:bool
    :return:这里写参数说明
    '''
    pass

---

查看说明文档

• 更多免费分享请点击这里

• 鼠标放在函数名上然后按快捷键Ctrl + Q即可查看函数说明文档
  

• 鼠标放在括号类会提示参数类型