pycharm如何为函数插入文档注释

目录

• pycharm为函数插入文档注释
• pycharm函数注释简单设置

pycharm为函数插入文档注释

S1 光标放在函数名上方，点击小灯泡，出现菜单

S2 选择 input documentation string stub ，即插入文档注释

S3 输入函数的各参数注释，返回值注释

pycharm函数注释简单设置

在安装PyCharm后可能存在函数自动注释无法使用的情况。

可以按照以下路径：File->Settings->Tools->Python Intrgrated Tools->Docstrings->Docstring format 进行修改

修改后，在函数下方输入三个 " 回车就会自动添加相应格式的注释

'''
@Project : python
@File    : TEST
@Author  : [email protected]
@Data    : 2021/3/22 10:26
'''
def newfunc(a,b):
    """
    Args:
        a:
        b:
    Returns:
    """
    pass

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。