Pycharm 中 py 文件预设 文件头部信息

一、设置模板步骤：

“文件File–设置Settings–编辑器Editor–File and Code Templates- Python Script” 里面设置模板

示例：

#！/usr/bin/env python
# -*-coding:Utf-8 -*-
# Time: ${DATA} ${TIME}
# FileName: ${NAME}
# Tools: ${PRODUCT_NAME}

二、其他

其他可用的预定义文件模板变量为：
$ {PROJECT_NAME} - 当前项目的名称。
$ {NAME} - 在文件创建过程中在“新建文件”对话框中指定的新文件的名称。
$ {USER} - 当前用户的登录名。
$ {DATE} - 当前的系统日期。
$ {TIME} - 当前系统时间。
$ {YEAR} - 今年。
$ {MONTH} - 当月。
$ {DAY} - 当月的当天。
$ {HOUR} - 目前的小时。
$ {MINUTE} - 当前分钟。
$ {PRODUCT_NAME} - 将在其中创建文件的IDE的名称。
$ {MONTH_NAME_SHORT} - 月份名称的前3个字母。 示例：1月，2月等
$ {MONTH_NAME_FULL} - 一个月的全名。 示例：1月，2月等
Author作者可以直接写自己的名字，而不使用 $ {USER}

三、开启PyCharm自动函数文档注释

开启步骤：File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format

Docstring format包括五种风格：Plain（默认）、Epytext、reStructuredText、NumPy和Google

其中，常用的是Epytext和reStructuredText风格

1） Epytext效果：

def test(param1, param2):
    """
    Epytext风格
    @param param1:
    @param param2:
    @return:
    """
    ...

2） reStructuredText效果：

def test(param1, param2):
    """
    reStructuredText风格
    :param param1:
    :param param2:
    :return:
    """
    ...