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后,如下图所示:

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

相关推荐
Hylan_J44 分钟前
【VSCode】MicroPython环境配置
ide·vscode·python·编辑器
莫忘初心丶1 小时前
在 Ubuntu 22 上使用 Gunicorn 启动 Flask 应用程序
python·ubuntu·flask·gunicorn
失败尽常态5234 小时前
用Python实现Excel数据同步到飞书文档
python·excel·飞书
2501_904447744 小时前
OPPO发布新型折叠屏手机 起售价8999
python·智能手机·django·virtualenv·pygame
青龙小码农4 小时前
yum报错:bash: /usr/bin/yum: /usr/bin/python: 坏的解释器:没有那个文件或目录
开发语言·python·bash·liunx
大数据追光猿4 小时前
Python应用算法之贪心算法理解和实践
大数据·开发语言·人工智能·python·深度学习·算法·贪心算法
Leuanghing4 小时前
【Leetcode】11. 盛最多水的容器
python·算法·leetcode
xinxiyinhe5 小时前
如何设置Cursor中.cursorrules文件
人工智能·python
诸神缄默不语6 小时前
如何用Python 3自动打开exe程序
python·os·subprocess·python 3
橘子师兄6 小时前
分页功能组件开发
数据库·python·django