PyCharm 不能自动生成函数注释

PyCharm 中可以在新建文件自动生成文件头注释，实现自动生成运行环境，作者、日期等必要信息，使用比较方便，配置十分简单，具体设置可参考这篇博客。

另外，PyCharm在定义函数之后，可以自动生成包括参数和返回值在内的注释，具体使用方法为¹：

1. 函数定义后，另起一行，输入三个引号（单引号和双引号均可），后回车。

def f(b,c):
'''

2. 结果为：

def a(b,c):
    '''
    
    :param b:
    :param c:
    :return:
    '''

但是，笔者发现，有一次安装后，定义函数之后不能按照此方法自动生成注释。查阅资料发现，原来是 PyCharm 的设置问题，设置方法如下²：

按照如上1-4的步骤，即在 File | Settings | Tools | Python Integrated Tools | Docstring format 中将 Docstring format 改为 reStructuredText，此处如果是 plain 就导致定义函数之后不能自动生成注释。

---

1. pycharm使用笔记3-自动生成文件注释和函数注释 ↩︎

2. 请问PyCharm有没有可以自动生成函数注释的插件？ - 宇总啥都不懂的回答 - 知乎 ↩︎