本文主要介绍pycharm如何为函数插入文档注释,很有参考价值,希望对大家有所帮助。如有错误或考虑不全面,请告知。

pycharm为函数插入文档注释

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

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

pycharm如何为函数插入文档注释插图
S3 输入函数的各参数注释,返回值注释

pycharm如何为函数插入文档注释插图1
pycharm函数注释简单设置

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

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

pycharm如何为函数插入文档注释插图2
pycharm如何为函数插入文档注释插图3
修改后,在函数下方输入三个 ” 回车就会自动添加相应格式的注释

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

以上为个人经验,希望能给大家一个参考

发表回复

您的电子邮箱地址不会被公开。