idea 设置注释模板_pycharm设置python文件模板，自动添加文件头注释

本文使用 Zhihu On VSCode 创作并发布

1.背景

每次写python代码的时候，都要手动在文件开头加上python解释器路径，文件编码，作者，日期等一堆信息，感觉非常麻烦。作为一个程序员，要学会偷懒。

2.环境信息

• windows10 64位操作系统
• PyCharm 2019.3.3

3.如何设置代码模板

避免每次新建项目文件时添加注释文件名、作者、创建日期等信息，则可以设置较好的代码模板，在创建文件时自动生成相关信息。

3.1 设置步骤：打开PyCharm，选择File --> Settings --> Editor --> Code Style --> File and Code Templates --> Python Script

模板设置

模板填写好之后，点击右下角的Apply。

3.2 文件模板效果如下：

模板效果

我的文件模板如下：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : ${DATE} ${TIME}
# @Author  : 一叶知秋
# @File    : ${NAME}.py
# @Software: ${PRODUCT_NAME}

3.3 根据个人喜好还可以有不同的添加、设计，预定义的变量要扩展为格式为$ {<variable_name>}的相应值，可用的预定义文件模板变量为：

$ {PROJECT_NAME} - 当前项目的名称。

$ {NAME} - 当前文件名。

$ {USER} - 当前用户的登录名。

$ {DATE} - 当前的系统日期。

$ {TIME} - 当前系统时间。

$ {YEAR} - 当年。

$ {MONTH} - 当月。

$ {DAY} - 当月的当天。

$ {HOUR} - 目前的小时。

$ {MINUTE} - 当前分钟。

$ {PRODUCT_NAME} - 将在其中创建文件的IDE的名称。

$ {MONTH_NAME_SHORT} - 月份名称的前3个字母。 示例：1月，2月等

$ {MONTH_NAME_FULL} - 一个月的全名。 示例：一月，二月等

最后，赶紧来设置你自己的文件模板吧！

参考链接

• https://www.cnblogs.com/gujianshuang/p/7801574.html