正常使用Pycharm,对定义的函数书写注释(三个引号),Pycharm是会自动生成函数参数和返回值的注释格式,如下:
问题展示
# 定义一个函数
def test(a, b):
"""
# 再输入三个引号(单引号和双引号均可)后回车,会自动生成函数参数和返回值的注释
pass
正常情况:
输出结果为
def test(a, b):
'''
:param a:
:param b:
:return:
'''
但是今天再使用的过程中确突然不会自动生成了,应该是自己不小心动了哪里的设置。在查阅资料后发现解决方法(Windows和mac都是一样的解决方法)为:
解决方法
按照顺序选择对应选项:
File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format
进入到Docstring format后 将 Docstring format 改为 reStructuredText,此处如果是 plain 就导致定义函数之后不能自动生成注释。
图片展示
图片版(图片是中文版选项):
![pycharm设置界面](https://www.linfengnet.com/wp-content/uploads/2022/07/2022073118035496.png)
![pycharm设置-python集成工具设置界面-中文版](https://www.linfengnet.com/wp-content/uploads/2022/07/2022073118040335.png)
英文/mac版本图例:
英文版:
![pycharm设置-python集成工具设置界面-英文版](https://www.linfengnet.com/wp-content/uploads/2022/07/2022073118061736.png)
mac版:
![pycharm设置-python集成工具设置界面-mac版](https://www.linfengnet.com/wp-content/uploads/2022/07/202207311806307.png)