查看: 121|回复: 3

PyCharm新建py文件自动生成文件头注释与模板变量配置

[复制链接]
发表于 1 小时前 | 显示全部楼层 |阅读模式
在脚本项目中,每新建一个 Python 文件都手动补作者、日期和文件说明,既重复又容易漏写。PyCharm 可以通过文件代码模板,在创建 py 文件时自动填充统一头注释。下面按原文给出的模板和配置思路,说明具体做法、变量含义以及常见排查点。

一、配置入口与模板位置

在 PyCharm 设置中找到 Editor → File and Code Templates,在 Files 列表中选择 Python Script。这个模板决定新建 Python 文件时自动写入的初始内容。把原本为空的模板替换成自己的头注释即可,已有文件不会被回溯修改,只对之后新建的文件生效。

二、文件头注释模板写法

原文使用的模板如下,可直接放入 Python Script 模板中:
  1. # do what you say,say what you do
  2. # @Author :xulai
  3. # @File :== ${NAME}.py ==
  4. # @Date :${DATE} ${TIME}
  5. # @Describe:
复制代码

这段模板包含固定说明、作者、文件名、创建日期时间和描述占位。新建文件时,PyCharm 会把变量替换成实际值,固定文本则原样保留。

三、模板变量含义

${NAME} 表示创建文件时输入的文件名。原文在变量后追加了 .py,用于在注释中显示完整文件名;如果实际创建时文件名已经带扩展名,需要留意是否会出现重复后缀。

${DATE} 和 ${TIME} 分别表示创建文件时的当前日期与时间,二者常常连用,形成“日期 时间”的创建记录。它们由 IDE 在生成文件时展开,不是 Python 运行时变量,因此不会在脚本执行阶段动态变化。

@Author 后面的 xulai 是原文采用的固定作者名。若团队需要统一作者标识,可以保留固定值;若希望每个开发者使用自己的名称,则需要另行调整模板内容,不能把固定文本误认为自动变量。

@Describe: 是描述占位,方便新建文件后补充用途说明,本身不会自动生成业务描述。

四、生效方式与验证

保存模板后,通过 File → New → Python File 新建一个 py 文件,输入文件名并确认。生成的文件顶部应出现模板中的注释内容,${NAME}、${DATE}、${TIME} 应被替换为实际文件名、日期和时间。若仍显示原始变量或没有注释,优先检查是否修改了 Python Script 模板,而不是其他文件类型模板。

五、常见问题排查

第一,模板未生效时,确认修改的是 Files 下的 Python Script,并检查模板是否已保存。第二,已有文件不会自动追加头注释,模板只影响新建文件。第三,文件名展示异常时,检查 ${NAME} 后是否重复添加了 .py。第四,日期时间格式与预期不一致时,检查系统区域设置或 IDE 相关格式配置。第五,团队协作中如果多人使用不同模板,头注释字段会不统一,建议把模板内容作为项目规范固定下来。

六、适用场景

这种配置适合 Python 脚本、自动化工具、小型后端项目和教学示例等需要频繁新建 py 文件的场景。它能减少重复输入,让文件头部的作者、创建时间和文件说明保持一致。对于已经存在的历史文件,仍需单独补注释;模板配置解决的是新建文件时的初始化问题,而不是批量修改旧文件。
回复

使用道具 举报

发表于 1 小时前 | 显示全部楼层

Re: PyCharm新建py文件自动生成文件头注释与模板变量配置

这个配置思路挺实用的,尤其适合经常新建 Python 脚本的场景。把作者、文件名、创建日期时间和描述统一放到 Python Script 文件模板里,确实能减少重复输入,也能避免漏写头注释。 我比较认同文中强调的几点:模板只对新建文件生效,已有文件不会自动补;检查时要确认改的是 Files 下的 Python Script,而不是其他文件类型模板;另外 ${NAME} 后面如果又手动加了 .py,确实容易出现重复后缀,新建测试文件验证一下比较稳妥。 @Author 用固定值还是个人名,也值得提前定好。团队里如果希望统一作者标识,就可以固定;如果每个人想写自己的名字,就需要让大家各自调整模板,或者干脆按项目规范来。总体来说,这个做法成本不高,适合脚本、自动化工具和小项目起步时先把文件头规范起来。
回复 支持 反对

使用道具 举报

发表于 1 小时前 | 显示全部楼层

Re: PyCharm新建py文件自动生成文件头注释与模板变量配置

这个配置思路挺实用,按 Editor → File and Code Templates → Python Script 来改,确实比每次新建文件手写头注释省事。模板里 ${NAME}、${DATE}、${TIME} 的说明也很清楚,尤其是提醒它们由 IDE 生成时展开,不是运行时变量,这点容易误解。 我觉得有两个地方特别值得注意:一是 ${NAME} 后面追加 .py 可能出现重复后缀,新建时文件名最好确认一下;二是模板只影响之后新建的文件,已有文件不会自动补注释,历史文件还得单独处理。另外作者名如果固定成 xulai,团队协作时最好提前约定统一规范,或者按需要调整模板内容。常见排查点列得挺全,感谢分享。
回复 支持 反对

使用道具 举报

发表于 1 小时前 | 显示全部楼层

Re: PyCharm新建py文件自动生成文件头注释与模板变量配置

感谢楼主分享,步骤写得很清楚,尤其是把模板变量含义和生效方式分开说明,照着做比较容易理解。关于文件名那里确实要留意,${NAME} 后面已经追加了 .py,如果新建时输入的文件名也带扩展名,就可能出现重复后缀,排查时可以先看这一点。另外模板只对之后新建的文件生效,已有文件不会被自动补头注释,这个提醒也很实用。团队协作时把模板内容固定成项目规范,应该能减少头注释字段不统一的问题。整体是一篇挺实用的配置说明,收藏了。
回复 支持 反对

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

指导单位

江苏省公安厅

江苏省通信管理局

浙江省台州刑侦支队

DEFCON GROUP 86025

Hacking Group 021A

旗下站点

态势感知中心

应急响应中心

红盟安全

联系我们

官方QQ群:112851260

官方邮箱:security#ihonker.org(#改成@)

官方核心成员

关注微信公众号

Archiver|手机版|小黑屋| ( 沪ICP备2021026908号 )

GMT+8, 2026-11-20 03:20 , Processed in 0.023376 second(s), 18 queries , Gzip On, Redis On.

Powered by ihonker.com

Copyright © 2015-现在.

  • 返回顶部