PyCharm 配置自动添加 Python 文件头注释

半杯拿铁
半杯拿铁
发布时间:2026-10-13| 6人浏览过
原创

本文介绍如何在 PyCharm 中通过 File and Code Templates 配置 Python Script 模板,实现新建文件时自动插入包含作者、版权、时间及描述信息的文件头注释,提升代码规范性与开发效率。

打开 PyCharm 编辑器,依次点击菜单栏中的 File 选项,随后选择 Settings 进入设置界面。

在设置窗口左侧导航栏中,找到并展开 File and Code Templates 分类,点击其下的 Files 子项,最后选中 Python Script 选项。

在右侧编辑区域中,可以自定义代码模板的具体样式与内容。

#!/usr/bin/env python
# encoding: utf-8
'''
@author: caopeng
@license: (C) Copyright 2013-2017, Node Supply Chain Manager Corporation Limited.
@contact: deamoncao100@gmail.com
@software: garner
@file: ${NAME}.py
@time: ${DATE} ${TIME}
@desc:
'''

保存设置后,新建一个 Python 文件,此时生成的文件内容将自动包含预设的文件头注释,效果如下图所示。

以上关于在 PyCharm 创建 Python 文件时自动添加文件头注释的操作步骤即为完整内容,希望能为读者提供有效参考,欢迎持续关注本站获取更多技术分享。

相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。