版权声明：本文为博主原创文章，未经博主允许不得转载。python版本为python3，实例都是经过实际验证。 https://blog.csdn.net/jinxiaonian11/article/details/83410323
1. 文件注释
pycharm提供了一个在新建文件自动生成文件头注释的功能，可以实现自动生成运行环境，作者、日期等必要信息，使用比较方便，配置十分简单。
按照1-5的路径选项即可。在5中填写想要的注释。
我的模板：
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
'''
@File : ${NAME}.py
@Contact : [email protected]
@License : (C)Copyright 2017-2018, Liugroup-NLPR-CASIA
@Modify Time @Author @Version @Desciption
------------ ------- -------- -----------
${DATE} ${TIME} gxrao 1.0 None
'''
# import lib
2. 函数注释
自动生成函数注释，包括参数和返回值。
使用方法，函数定义时，直接输入三个双引号后回车，例如：
def a(b,c):
另起一行，输入三个引号，后回车
def a(b,c):
"""
结果：
def a(b,c):
"""
:param b:
:param c:
:return:
"""