优草派  >   Python

如何在Python文件头部进行注释?pycharm中写python脚本头注释的方法有哪些?

翟嘉慧            来源:优草派

在pycharm中写python脚本时在开头添加作者、日期等信息能方便了解该脚本由谁完成、何时完成、所要实现的基本功能等,使得脚本书写更加规范化。那么该如何进行这项操作呢?下面就一起来看看这篇文章吧。

如何在Python文件头部进行注释?pycharm中写python脚本头注释的方法有哪些?

一、文件头部注释

在网页中浏览别人的代码时,可以看到有些代码的最前面的位置会增加有些作者的名字或者是编写程序的日期,我们将这些称之为开头注释,就是在编写程序的时候,在脚本的开头位置添加作者、日期等信息,这样可以让大家在阅读程序的时候,知道这个脚本是由谁编写的,使得脚本的书写更加的规范化。下面就给大家详细的讲解添加的方法,具体的操作如下:

二、设置文件开头注释的路径

1、pycharm编辑器,进入到编辑的界面中,找到顶部的菜单中的file选项,再点击下拉菜单中的settings,如下图所示:

如何在Python文件头部进行注释?pycharm中写python脚本头注释的方法有哪些?

2、进入到settings中之后,点击左侧的Editor选项,这是专门对pycharm界面进行设置的一个选项,点击之后会 弹出一些子菜单,选择“ File and Code Templates ”。最后在右侧的界面中点击“Python Script ”,如图所示:

如何在Python文件头部进行注释?pycharm中写python脚本头注释的方法有哪些?

3、在下图中的date使用的 #date:${DATE} ${TIME} 就是会自动打印当前日期,如果在author中使用 #author:${USER} ,就会把当前Windows系统的用户打印出来,如下图所示:

如何在Python文件头部进行注释?pycharm中写python脚本头注释的方法有哪些?

到此这篇关于如何在Python文件头部进行注释?pycharm中写python脚本头注释的方法有哪些?的文章就分享到这里了,希望大家可以通过对这篇文章的学习掌握到更多的Python知识。

【原创声明】凡注明“来源:优草派”的文章,系本站原创,任何单位或个人未经本站书面授权不得转载、链接、转贴或以其他方式复制发表。否则,本站将依法追究其法律责任。