在 PyCharm 中设置新建文件自动添加文件头描述

在 PyCharm 中设置新建文件自动添加文件头描述，核心是修改 File and Code Templates 里的 Python Script 模板，以后新建 .py 文件就会自动带上你写的描述。

一、设置步骤（Windows/Linux）

1. 打开设置：

   • 菜单：File → Settings

   • 快捷键：Ctrl + Alt + S

2. 进入模板配置：

   • 左侧：Editor → File and Code Templates

   • 右侧切换到 Files 标签

3. 选择模板：

   • 找到并选中 Python Script

4. 编辑模板内容：

   • 在右侧编辑区，粘贴/修改你的文件头模板（示例见下文）

5. 保存生效：

   • 点击 Apply → OK

   • 重启 PyCharm 更稳妥

二、macOS 操作路径

• 菜单：PyCharm → Preferences

• 后续路径：Editor → File and Code Templates → Files → Python Script

三、常用文件头模板（直接复制使用）

1. 简洁版（推荐）

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
@File : ${NAME}.py
@Author : ${USER}
@Date : ${DATE} ${TIME}
@Project : ${PROJECT_NAME}
@Desc :
"""

2. 完整版（含版权/版本）

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
@File : ${NAME}.py
@Author : ${USER}
@CreateDate : ${DATE} ${TIME}
@Project : ${PROJECT_NAME}
@Version : 1.0
@Description :
@Copyright : (c) ${YEAR} Your Company
"""

四、常用内置变量（直接用）

• ${NAME}：文件名（不含后缀）

• ${USER}：当前系统用户名

• ${DATE}：日期（如 2026-02-10）

• ${TIME}：时间（如 18:45:30）

• ${YEAR}：年份（2026）

• ${PROJECT_NAME}：当前项目名

五、作用范围（Scheme）

• Default：所有项目都生效（全局）

• Project：仅当前项目生效（存在 .idea/fileTemplates）

六、验证

新建一个 .py 文件，会自动生成你设置的文件头。

需要我帮你定制一个更贴合 Django 项目的文件头模板吗？