最近，PyCharm开发工具的AI自动生成代码注释的插件被下架了。
于是，只能又去找找有什么新的注释模板可以帮助我更快的添加函数、python文件的注释。
这里特别记录一下，一来免得以后忘记，二来给有需要的小伙伴提供帮助。
首先是文件模板注释，一般文件注释模板基本都是一样的。下面可以通过截图看一下效果。
下面是我这里需要配置的文件注释模板，小伙伴们可以根据自己的需求进行调整。
# -*- coding: utf-8 -*-
# @Time : ${DATE} ${TIME}
# @Author : w.sir
# @File : ${NAME}.py
# @Description : 公众号：Python 集中营
若是需要在文件注释模板中配置更多的变量，小伙伴们可以参考下面的模板注释变量的说明，制定自己专属的文件模板。
下面是函数模板的设置方式，因为PyCharm本身自带了四种形式的模板风格。
这四种风格分别是Epytext、restructedText、Numpy、Google，四种风格各不相同，小伙伴们可以选择自己喜欢的设置。
下面分别是PyCharm开发工具自带的四种风格的注释模板添加函数注释的效果。
def test1(param1=None,param2=None):
'''
Epytext注释模板
@param param1:
@param param2:
@return:
'''
print('函数注释测试')
return None
def test2(param1=None,param2=None):
'''
restructedText注释模板
:param param1:
:param param2:
:return:
'''
print('函数注释测试')
return None
def test3(param1=None,param2=None):
'''
Numpy注释模板
Parameters
----------
param1
param2
Returns
-------
'''
print('函数注释测试')
return None
def test4(param1=None,param2=None):
'''
Google注释模板
Args:
param1:
param2:
Returns:
'''
print('函数注释测试')
return None
四种函数注释模板各有不同，我平常使用的就是restructedText风格的函数模板，小伙伴们可以根据自己的喜好选择。
