Pycharm：py文件头部自动添加注释

原创于 2025-07-09 19:43:12 发布 · 385 阅读

5 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

标签

#pycharm #python

Python3.8

Python 是一种高级、解释型、通用的编程语言，以其简洁易读的语法而闻名，适用于广泛的应用，包括Web开发、数据分析、人工智能和自动化脚本

1. 进入 Python Script 设置

首先按照以下路径，进入 Python Script 设置：

英文版：进入 File -> settings -> Editor -> File and Code Templates -> Python Script

汉化版：文件 -> 设置 -> 编辑器 -> 文件和代码模板 -> Python Script

进入后如图所示：

2. 设置 py 文件的默认模版头部信息

可以根据官方预设变量表自定义想要添加的 py 文件头部注释，官方预设变量表如下所示：

变量名含义
${DATE} 当前系统日期
${DAY} 当前月的第几日
${DAY_NAME_SHORT} 当前星期几的单词缩写（前三个字母）
${DAY_NAME_FULL} 当前星期几的单词
${DIR_PATH} 文件相对于项目根目录的相对路径
${DS} 此变量用于输出转义美元字符，因为转义美元字符串不能直接出现在模板定义里
${FILE_NAME} 文件名
${HOUR} 当前小时
${MINUTE} 当前分钟
${SECOND} 当前秒数
${MONTH} 当前月份
${MONTH_NAME_SHORT} 当前月的单词缩写（前三个字母）
${MONTH_NAME_FULL} 当前月的单词
${NAME} 当前实体名称（文件、类别、接口等）
${ORGANIZATION_NAME} 项目设置中定义的组织名称
${PRODUCT_NAME} 项目设置中的产品名称
${PROJECT_NAME} 项目名称
${TIME} 当前系统时间
${USER} 当前操作系统登录用户
${YEAR} 当前年份

下面是自定义的模板，其中“# @Author : ”替换为自己名字：

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

效果如下所示：