Pycharm函数注释模板的简单修改方法
背景:
在pycharm中定义函数时,不喜欢默认自动生成的函数注释模板,希望换成更美观的格式。
Pycharm默认自动生成的函数注释模板
如下图,在pycharm定义函数时,单/双三引号添加函数注释,pycharm会自动帮助生成注释模板。个人觉得不是很美观,用着不习惯。
函数注释模板修改的简单方法
经查阅,该注释模板可以自定义,也有现成的常用注释模板格式供选择。
后来发现直接选择现成注释模板更方便,比如“Google”注释模板格式。相比而言,自定义方法显得繁琐,而且个人觉得没必要花这时间。
以下是选择现成常用注释模板格式的方法:
在pycharm窗口中,依次选择:File→Setting→Tools→Python Integrated Tools→Docstrings→Docstring format: 在下拉菜单中选择“Google” 或是其他你喜欢的格式。
如下图,是Google格式的函数注释模板: