【Python】解决Pycharm不能自动生成函数注释

• Z时代
• 2024-01-10
• 分类：技术分享

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

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

def f(b,c):
'''

1. 输出结果为

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

但是，最近在使用的时候发现，定义函数之后不能按照此方法自动生成注释。查阅资料发现，原来是 PyCharm 的设置问题，解决方法如下

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

以上是 【Python】解决Pycharm不能自动生成函数注释 的全部内容， 来源链接： utcz.com/a/90834.html