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

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

相关推荐
CodeCraft Studio1 分钟前
借助Aspose.Email,使用 Python 将 EML 转换为 MHTML
linux·服务器·python·aspose·email·mhtml·eml
SkylerHu1 分钟前
MacOS 使用ssh2-python报错ImportError: dlopen ... _libssh2_channel_direct_tcpip_ex
python·macos·ssh2
计算机软件程序设计7 小时前
基于Python的二手车价格数据分析与预测系统的设计与实现
开发语言·python·数据分析·预测系统
mortimer8 小时前
Traceback 模块:`format_exc` 和 `format_exception` 傻傻分不清
python
Cherry Zack8 小时前
了解Django模型,从基础到实战
python·学习·django
qq7422349849 小时前
语音识别:PyAudio、SoundDevice、Vosk、openai-whisper、Argos-Translate、FunASR(Python)
python·whisper·语音识别
曾经的三心草9 小时前
OpenCV2-图像基本操作-阈值与平滑处理-形态学-梯度运算
python·opencv
xiangzhihong89 小时前
Spring Boot实现文字转语音功能
开发语言·python
天才测试猿10 小时前
postman使用总结
自动化测试·软件测试·python·测试工具·测试用例·接口测试·postman
可触的未来,发芽的智生11 小时前
新奇特:神经网络烘焙坊(下),万能配方的甜蜜奥义
人工智能·python·神经网络·算法·架构