pycharm创建py文件怎么自动添加文件头注释(Name,Author,Content,Time,Desc)

本文介绍如何在PyCharm中设置自动添加文件头注释,包括创建时间、作者和文件名等信息,通过调整CodeStyle和File Templates实现。

有时候我们在使用pycharm的时候,想创建py文件的时候,自动添加文件头注释,包括创建时间,作者,文件名称等,怎么操作呢,下面来分享一下方法

如果对你有用的话,关注我吧

1.打开pycharm,点击file-->settings

2.Editor-->Code Style-->File and Code Templates-->Python Script

3.python script中的代码

#!/usr/bin/env python
# coding:utf-8
"""
Name : ${NAME}.py
Author  : 写上自己的名字
Contect : 邮箱地址
Time    : ${DATE} ${TIME}
Desc:
"""

4.我们来创建一个脚本,来看看效果

 

PyCharm 中设置创建文件自动生成文件头注释,可以通过配置 **File and Code Templates** 来实现。以下是详细的设置方法: ### 配置文件头注释模板 1. 打开 PyCharm,点击菜单栏的 `File`,然后选择 `Settings`(在 macOS 上为 `Preferences`)。 2. 在设置窗口中,依次选择 `Editor` → `File and Code Templates`。 3. 在右侧的模板列表中找到 `Python Script`,点击进入编辑界面。 4. 在模板编辑区域输入你希望自动生成的文件头注释内容。例如: ```python #!/usr/bin/env python # -*- coding: UTF-8 -*- ''' @Project :${PROJECT_NAME} @File :${NAME}.py @IDE :${PRODUCT_NAME} @Author :${USER} @Date :${DATE} ${TIME} @Description: 请在此处添加文件功能描述 ''' ``` 该模板使用了 PyCharm 提供的预定义变量,如 `${PROJECT_NAME}` 表示项目名称,`${NAME}` 表示文件名,`${DATE}` 和 `${TIME}` 分别表示当前日期和时间[^2]。 ### 可用变量说明 PyCharm 提供了一系列预定义变量,用于动态插入信息到模板中,包括: - `${PROJECT_NAME}`:项目名称。 - `${PRODUCT_NAME}`:IDE 名称(如 PyCharm)。 - `${NAME}`:新建文件的名称。 - `${USER}`:当前操作系统的用户名。 - `${DATE}`:当前日期(格式为年-月-日)。 - `${TIME}`:当前时间(格式为时:分:秒)。 - `${YEAR}`:当前年份。 - `${MONTH}`:当前月份(两位数字)。 - `${MONTH_NAME_SHORT}`:当前月份的短名称(如 7月)。 - `${MONTH_NAME_FULL}`:当前月份的全称(如 七月)。 - `${DAY}`:当月的第几天。 - `${HOUR}`:当前小时。 - `${MINUTE}`:当前分钟。 - `${SECOND}`:当前秒数[^2]。 ### 应用模板并查看效果 完成模板编辑后,点击 `Apply` 或 `OK` 以保存更改。之后,每次新建 `.py` 文件时,PyCharm自动应用你设置的模板,并填充相应的变量内容。 例如,新建一个名为 `example.py` 的文件,生成的文件头注释可能如下所示: ```python #!/usr/bin/env python # -*- coding: UTF-8 -*- ''' @Project :MyProject @File :example.py @IDE :PyCharm @Author :admin @Date :2025-04-05 14:30:00 @Description: 示例文件,用于演示自动生成的文件头注释 ''' ``` ### 其他注意事项 - 模板内容可以根据个人或团队需求进行自定义,确保统一性和规范性。 - 如果需要调整光标位置(例如,希望新建文件时光标自动跳转到特定行),可以通过修改代码模板配合 Live Templates 实现[^3]。
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值