pycharm新建.py文件时自动添加文件头注释需配置file→settings→editor→file and code templates→python script模板,使用${date}、${time}、${user}、${name}等内置变量生成动态信息,仅对全新创建的python file生效。

PyCharm 新建 .py 文件时,默认不带任何头部注释;想让它自动加,必须手动配置模板——不是插件、不用写脚本,改一个地方就生效。
在哪改 Python 文件头模板
路径很固定:File → Settings → Editor → File and Code Templates → Python Script(macOS 是 PyCharm → Preferences)。别去搜“代码风格”或“编辑器外观”,那里面没有模板入口。点进去后右侧是纯文本编辑区,直接写注释内容即可。
常见错误:改了 Files 标签页下的 “Python Script” 模板,却在 Code 标签页里改函数模板——后者只影响 def 函数内部的代码补全,跟文件头无关。
怎么写能自动填日期和作者
PyCharm 内置变量用 ${...} 语法,大小写敏感,不能写成 $DATE 或 ${date}。常用且稳定的有:
-
${DATE}和${TIME}:生成形如2026/07/31和15:55:22的值,注意它们不会实时刷新,只在文件创建瞬间取值 -
${USER}:取操作系统当前登录用户名,不是 Git 配置里的user.name,所以多人共用一台机器时会一致 -
${NAME}:新建文件时你输入的文件名(不含.py),比如建main.py,${NAME}就是main -
${PROJECT_NAME}:当前打开的 PyCharm 项目根目录名,不是 IDE 窗口标题,也不是 Git 仓库名
示例模板(可直接复制):
Python 3.14.2是Python编程语言在2025年12月5日发布的稳定版本,属于3.14系列的第二个维护更新。该版本包含了18项修复,重点解决了多进程、数据类及正则表达式等模块的回归问题,并修复了CVE-2025-12084等安全漏洞。此版本标志着自由线程模式(移除GIL)正式获得官方支持,是Python发展的重要里程碑。
# -*- coding: utf-8 -*-
"""
@File : ${NAME}.py
@Author : ${USER}
@Date : ${DATE} ${TIME}
@Project : ${PROJECT_NAME}
"""
注意开头留空行,否则生成的 """ 可能紧贴 # -*- ... -*-,部分 linter 会报编码声明位置警告。
为什么新建文件没生效
模板只对「全新创建」的文件起作用,不修改已有文件。常见失效场景:
- 用
Ctrl+N新建的是Empty File,不是Python File——必须选Python File或右键项目目录 →New → Python File - 模板里写了语法错误(比如多了一个
'''),PyCharm 不报错但会静默跳过渲染,结果文件头为空 - 改完模板没点
Apply,只点了OK——Apply才真正保存,OK只是关闭窗口 - 用了已废弃变量,比如
${YEAR}-${MONTH}-${DAY}在较新版本中可能返回空,老版本才支持;坚持用${DATE}最稳
作者名想固定而不是用 ${USER}
直接把 ${USER} 换成真实姓名或邮箱就行,比如 @Author : zhangsan@company.com。但要注意:
- 如果团队统一规范,建议保留
${USER},避免换人开发时漏改 - 若用中文名,确保系统区域设置支持 UTF-8,否则
${USER}可能乱码(此时硬编码更可靠) -
${USER}值来自系统环境变量USERNAME(Windows)或LOGNAME(macOS/Linux),改系统用户名才能同步更新
真正容易被忽略的点是:模板生效依赖新建动作的类型,以及变量是否被 PyCharm 当前版本实际支持——别迷信网上搜到的冷门变量,优先用 ${DATE}、${NAME}、${USER} 这三个最无兼容风险的。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!










