Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?

自己在学习Python,看到许多人在用Sublime Text这款软件,今天下载下来研究了一下。

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 Sublime Text

今天主要想学习一下如何自动给代码添加作者信息等注释,于是从fileheader这款插件入手。

首先来看一下想实现的效果:

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 效果图

我查了好些CSDN上面的教程,发现写得实在是简单到让人无力吐槽,有些戛然而止,有些却不配图,让人不知所云,我花了近一个小时才实现上图的效果,下面进入教程正文:

1.安装File Header 插件

首先按Ctrl+`快捷键打开如下图所示的界面:

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 图①

访问下面的网址:https://packagecontrol.io/installation

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 图②

将红框内的文字复制到图①中方框内的光标处,然后回车,稍等片刻后,查看是否已经包含下图信息:

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 图③

2.添加作者信息键值

依次点开Preferences -> Pacakge Settings -> File Header -> Setting User

这里简单列举了几类,修改成自己的信息,如我将author改成自己的信息,稍后会用到。

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 图④

然后依次点开Preferences -> Browse Pacakges,然后选择FileHeader -> template -> header,这里包含了许多.tmpl文件,我这里用Python来举例,用记事本打开Python.tmpl

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 图⑤

此处就对应了刚才的author。

注意:这个文件千万不要修改,假如把author改成其他单词,就不能链接刚才author后面对应的文字了。

3.新建文件,自动生成注释

按Ctrl+N新建文件,然后保存到电脑上某个位置

注意:此时一定要给文件注明后缀!!!直接默认的话,生成的文件为txt文件,不会包含想要的注释,此处我用Python,后缀为.py,保存后自动生成注释文件,见文首效果图。

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》 图⑥

调出左侧的文件栏,然后操作如下:

《Python | 在Sublime Text如何调用fileheader自动给代码添加作者信息等注释?》

    原文作者:涤小生2019
    原文地址: https://www.jianshu.com/p/a19890805fd4
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞