pycharm使用笔记--自动生成文件注释和函数注释

1. 文件注释

pycharm提供了一个在新建文件自动生成文件头注释的功能，可以实现自动生成运行环境，作者、日期等必要信息，使用比较方便，配置十分简单。

打开方式：File-->settings-->Editor-->File and Code Templates-->Python Script

按照1-5的路径选项即可。在5中填写想要的注释。

我的模板：

预定义的变量

# !/usr/bin/env python3
# _*_ coding:utf-8 _*_
"""
@File     : ${NAME}.py
@Project : ${PROJECT_NAME}
@Time     : ${DATE} ${TIME}
@Author   : Li JinTao
@Contact_1: li.jintao.dky@jibei.sgcc.com.cn
@Contact_2: ljt1412451704@aliyun.com
@Software : ${PRODUCT_NAME}
@License : (C)Copyright 2018-2028, Taogroup-NLPR-CASIA
@Last Modify Time      @Version     @Desciption
--------------------       --------    -----------
${DATE} ${TIME}        1.0             None
"""

if __name__ == '__main__':
    pass

变量	描述	例子
${DATE}	当前系统日期	2019 / 11 / 21
${DAY}	当月第几天	21
${DS}	$的转义	$
${FILE_NAME}	文件名	test.py
${HOUR}	当前小时	14
${MINUTE}	当前分钟	16
${MONTH}	当前月份	11
${MONTH_NAME_FULL}	当前月份全称	十一月
${MONTH_NAME_SHORT}	当前月份简称	11
${NAME}	文件、类、接口的名称	test
${ORGANIZATION_NAME}	组织名	huawei
${PRODUCT_NAME}	IDE的名	PyCharm
${PROJECT_NAME}	当前项目名	test
${TIME}	当前系统时间	14: 16
${USER}	当前用户登录名	Administrator
${YEAR}	当前年份	2019

2. 函数注释

自动生成函数注释，包括参数和返回值。
使用方法，函数定义时，直接输入三个双引号后回车，例如：

def a(b,c):

另起一行，输入三个引号，后回车

def a(b,c):
"""

结果：

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