亲宝软件园·资讯

展开

为函数插入文档注释

大奸猫 人气:0

pycharm为函数插入文档注释

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

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

在这里插入图片描述

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

在这里插入图片描述

pycharm函数注释简单设置

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

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

将Plain换为其他的任意模板,这里使用Goole,当然也可以自己创建模板

Plain可能无法使用,可以选择其他模板。推荐使用Google

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

'''
@Project : python
@File    : TEST
@Author  : threeegg@foxmail.com
@Data    : 2021/3/22 10:26
'''
def newfunc(a,b):
    """
    Args:
        a:
        b:
    Returns:
    """
    pass

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

加载全部内容

相关教程
猜你喜欢
用户评论