在实际项目开发时,为了让编写的每个代码文件易读、易于维护或方便协同开发时,我们都会在每一个代码文件的开头做一些注释,如作者,文档编写时间,文档的功能说明等。
利用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后,如下图所示:

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