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

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

相关推荐
黄忠1 小时前
01-系统架构设计-LangGraph状态机与多源异构RAG
python
zzzzzz3101 小时前
假如我是掘金管理员,我先给评论区装个'代码审查'系统
python·程序员·机器人
砍材农夫2 小时前
python环境|conda安装和使用(2)
后端·python
程序员龙叔15 小时前
编写高质量 Skill 系列 -- 如何设计需求分析与用例生成的 SKILL
自动化测试·软件测试·python·软件测试工程师·接口测试·性能测试·skill·ai测试
用户83562907805117 小时前
使用 Python 操作 Word 内容控件
后端·python
摇滚侠19 小时前
IDEA 创建 Java 项目 手动整合 SSM 框架
java·ide·intellij-idea
码云骑士19 小时前
32-慢查询排查全流程(下)-索引优化实战与最左前缀原则
python
闵孚龙19 小时前
《PyTorch 深度修炼》Dataset 和 DataLoader:数据如何喂给模型
人工智能·pytorch·python
goldenrolan20 小时前
A公司物料替代测试系统 v1.7:从需求到 exe/apk 的 AI 辅助全链路实践
android·自动化测试·软件测试·python·ai