koroFileHeader插件快速入门使用教程

摘要:
插件下载插件可以直接在vscode的扩展中查找koroFileHeader,但是有时候由于网络的问题会查找不到软件。插件配置koroFileHeader支持许多功能,但是不是所有功能都是需要,我们关注往往是如何配置注释内容和注释的一些选项。"fileheader.cursorMode":{//这部分是函数头的配置},"fileheader.customMade":{//这部分是文件头的配置}而setting.json中"fileheader.configObj":{.....}中的内容就是配置的内容,下面我以C语言注释配置进行简单的说明。这里选择一个值后设置wideSame为true即可。

前言

在实际开发中我们必须需要进行代码注释的编写来提高代码的可读性和可维护性。但是使用简单的代码模板来进行粘贴复制显然是一种低效率并且很low的方法,通过寻找,我发现vscode支持一款自动注释函数和文件头的插件koroFileHeader,这款插件可以设置固定的函数注释模板和文件注释模板来让使用者快速的进行文件的注释,在团队维护代码和进行代码规范统一时可以大大的减少时间,从而提高工作的效率。

插件下载

插件可以直接在vscode的扩展中查找 koroFileHeader,但是有时候由于网络的问题会查找不到软件。如下图所示:

image

所以可以进入vscode的插件网址https://marketplace.visualstudio.com/vscode 来进行插件的离线下载。具体如何进行插件的离线下载请自行百度。当我们安装插件重启后,vscode的扩展工具箱就有这个图标。

image

插件配置

koroFileHeader支持许多功能,但是不是所有功能都是需要,我们关注往往是如何配置注释内容和注释的一些选项。所以可以跟随本教程无脑的进行配置,一步一步的执行,一般是不会出现问题。

  1. 快捷键ctrl+,,打开设置,在设置中搜索fileheader

image

  1. 在进入配置文件后,得到一堆东西,其实不一定要搞懂,其实这就是配置文件罢了,注意这上面有两个重要的配置Fileheader:Cursor ModeFileheader:Cursor Mode

image

  1. 分别点击这两个,则在settings.json配置文件的最后会生成下面代码。

        "fileheader.cursorMode": { //这部分是函数头的配置
        
        },
        "fileheader.customMade": { //这部分是文件头的配置
        
        }
    
  2. setting.json"fileheader.configObj":{.....}中的内容就是配置的内容,下面我以C语言注释配置进行简单的说明。配置语言的格式,可以进行自定义语言格式的配置。这样生成的代码便会以你设置的头来产生模板。
    image

  3. 接下去就是配置函数头和文件头的注释模板。大家可以参考我写的模板整理自己需要的模板。![image-20210909023347647]image

        "fileheader.cursorMode": {
            "Funticon name": "Please write your function name here",
            "Berif": "Briefly describe the function of your function",
            "Author": "Krone",
            "Data": "Do not edit",
            "Note": "Need note condition",
            "param":"",
            "result":"",
            "Test_result":"Function self test result ok or fault"
        },
        "fileheader.customMade": {
            "Copyright": "",
            "file name": "File name",
            "Data":"Do not edit",
            "LastEditor": "",
            "LastData":"",
            "Describe":""
        }
    
  4. 最后配置几个选项就成功了,"openFunctionParamsCheck": true, 这个选项开启可以自动检查函数的参数然后生成函数的参数列表,是我觉的比较便利的选项。还有Data是内部的字段,要让插件自动写入时钟,那么就写Do not edit, 还有functionWideNum可以使得代码的排列更整齐。这里选择一个值后设置wideSametrue即可。最后的效果图如下,这样函数和文件的功能标注就一目了然。

image

关于快捷键,插件安装的默认快捷键为

Ctrl + Alt +i 文件头部注释快捷键

Ctrl + Alt + t 函数注释

但是我个人觉这个有点不是很符合手指的行为,所以我修改为shift+1shift+2,这样注释老代码就快的飞起。

免责声明:文章转载自《koroFileHeader插件快速入门使用教程》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇CefSharp 浏览器核心,爬虫yml在线格式转换工具(properties)下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

vscode入门使用教程(页面调试)

初次使用vscode时各种不适应,所有需要用到的功能貌似都需要单独安装插件才能用。这让很多初次使用vscode的朋友有点无所适从。 下面本人就带各位朋友学习下如何使用vscode来进行最基本的工作——页面启动与代码调试 一、安装vscode(已经安装的朋友忽略,直接进行第二步) 官网下载地址:https://code.visualstudio.com/do...

vscode安装设置go

vscode安装设置go vscode安装go配置 1、下载最新的vscode:https://code.visualstudio.com/docs/?dv=win 2、下载go:https://golang.org/dl/ 3、配置go的环境变量: [计算机]-->[属性]-->[高级系统设置]-->[环境变量]-->[新建]...

解决vscode无法提示golang的问题

https://github.com/Microsoft/vscode-go/wiki/Go-with-VS-Code-FAQ-and-Troubleshooting Q: Auto-completions stopped working. What do I do? Run gocode close in a terminal and try agai...

把VS Code打造成Java开发IDE

近期,公司推行正版化,本人使用的是JetBrains教育版,是不允许进行商业开发的,因此开启了艰难的备用IDE选型之路。最终,我选定了轻量级的Visual Studio Code(以下简称VS Code)。 各种IDE选型比较的过程就不赘述了,Eclipse、NetBeans、Srping Tools Suite等等,只能说青菜萝卜各有所爱。 插件淘沙 众...

vsCode mongoDB插件 Azure Cosmos DB

这是一款可以在vsCode中使用的 mongoDB可视化插件。 首先,先进行安装,当然我已经安装好了。 安装完成后,要重启下vsCode 会看到 然后 点击绿色的小按钮,选择MongoDB 再输入MongoDB的连接地址。当然要先把本地的mongoDB数据库打开,cmd黑窗口输入mongod --dbpath xxxx 打开本地数据库 输入完成...

vscode中使用markdown

title: vscode中使用markdown date: 2017-08-01 02:58:53 tags: [Markdown,vscode] 转载自http://www.cnblogs.com/rengised/p/6985031.html vscode 是微软推出一款轻量级的文本编辑工具,类似于sublime,由于其拥有丰富的插件,安装使用...