PyCharm 设置新建Python文件时自动在文章开头添加固定注释的方法

在实际项目开发时,为了让编写的每个代码文件易读、易于维护或方便协同开发时,我们都会在每一个代码文件的开头做一些注释,如作者,文档编写时间,文档的功能说明等。

利用PyCharm 编辑器,我们只需设置相关设置,即可以在我们新建文件时,自动为我们在标头添加注释,具体操作方法如下:

如上图,在PyCharm 编辑器左上角点开Main Menu菜单,

再点击File->Settings,打开Settings设置窗口,如下图:

在Settings中找到Editor->File and Code Templates,点选后,我们再点选Python Script,然后我们就可以再右边的空白框中添加我们固定的标头注释了。

我这里添加的内容是:

复制代码
"""
${NAME} - 

Author: ${USER}
Date: ${DATE}
"""

其中 N A M E 、 {NAME}、 NAME、{USER}、${DATE},是占位符,分别表示文件名、系统用户名、当前时间,当我们在创建Python文件时,它会自动获取相关信息并做好注释。如我新建一个example012.py后,如下图所示:

灵活利用该设置对我们养成良好编程习惯是有一定帮助的。

相关推荐
rgeshfgreh2 小时前
Python条件与循环实战指南
python
rgeshfgreh2 小时前
通达信LC1文件结构解析指南
python
七夜zippoe2 小时前
事件驱动架构:构建高并发松耦合系统的Python实战
开发语言·python·架构·eda·事件驱动
Kratzdisteln3 小时前
【MVCD】PPT提纲汇总
经验分享·python
一个无名的炼丹师3 小时前
GraphRAG深度解析:从原理到实战,重塑RAG检索增强生成的未来
人工智能·python·rag
用户8356290780514 小时前
用Python轻松管理Word页脚:批量处理与多节文档技巧
后端·python
进击的松鼠4 小时前
LangChain 实战 | 快速搭建 Python 开发环境
python·langchain·llm
小北方城市网4 小时前
第1课:架构设计核心认知|从0建立架构思维(架构系列入门课)
大数据·网络·数据结构·python·架构·数据库架构
我的offer在哪里4 小时前
Hugging Face:让大模型触手可及的魔法工厂
人工智能·python·语言模型·开源·ai编程
汤姆yu5 小时前
基于python大数据的协同过滤音乐推荐系统
大数据·开发语言·python