美文网首页生物信息学札记
如何给vscode编辑器增加author, email,最初编辑

如何给vscode编辑器增加author, email,最初编辑

作者: 天地本无心 | 来源:发表于2019-11-06 16:28 被阅读0次

Entities should not be multiplied unnecessarily.
如无必要,勿增实体。
---- 奥卡姆剃刀法则

以前一直在用vim作为编辑器,偶尔也会使用过sublime以及bluefish等等编辑器。但是最近决定用vscode来写代码,vscode是一个跨平台(macOS, windows, linux)的代码编辑器,并且具有丰富的插件。无意讨论编辑器的好坏,编辑器的好坏不重要,写出来的代码质量才是值得讨论的那个。

然而我们在编程实践中,经常需要在代码中加入一些文件头信息(File header information),比如这个代码的作者,作者邮箱,代码创作时间,最后修改时间等等。这些信息的添加实现,可以用一个vscode的插件,koroFileHeader来实现,效果图如下图(Figure1, Figure4)。

安装koroFileHeader插件只需要三步(Figure1):

  • 点击Step1处的图标
  • 在搜索框中输入koroFileHeader
  • 选中koroFileHeader插件,并点击install.
Figure1: 安装koroFileHeader插件

安装好koroFileHeader插件之后,还需要配置个性化的Json格式的信息。步骤如下(Figure2):

  • 点击File -> Preference -> Settings
  • 在出来的搜索框中输入Fileheader
  • 点即Figure2标红的地方5, 进入edit in settings.json

以我自己修改内容为例,添加了如下内容(Figure3)。更详细的配置信息,也可以参考github上该koroFileHeader插件作者的wiki文档

Figure2 更改koroFileHeader插件里的个性化配置信息

我自己添加的json配置文本:

{
    "fileheader.configObj": 
        {
        "beforeAnnotation": 
            {"py": "#!/usr/bin/env python\n# coding=utf-8" 
            }
        },


    "fileheader.customMade": 
        {"Author":"xuzhongtian",
        "LastEditors":"Xu Zhongtian",
        "email": "xuzhongtian11@163.com",
        "github": "https://github.com/BiocompZTXu",
        "Date":"Do not edit",
        "LastEditTime": "Do not edit",
        "motto": "Still water run deep",
        "Description":"Modify here please",
        "FilePath": "Do not edit"
        }, 


    "explorer.confirmDelete": false
}
Figure3 以个人的为例,举例说明如何修改json格式的配置信息

在修改配置文件之后,最后一个问题就是,怎么使用这个插件: ctrl+alt+i快捷键

使用方法也非常简单,以python脚本为例,File -> open file -> (Maybe need to be saved first) -> ctrl+alt+i快捷键(linux系统)

Figure4 如何在新生成的文件中插入表头信息,以python脚本为例

最后,使用效果如上。


Done.

相关文章

网友评论

    本文标题:如何给vscode编辑器增加author, email,最初编辑

    本文链接:https://www.haomeiwen.com/subject/ljiubctx.html