首页 > 其他分享 >vscode自动注释插件的使用

vscode自动注释插件的使用

时间:2024-03-10 16:55:22浏览次数:28  
标签:文件 插件 string vscode custom 注释 edit

如果是工作中写代码,经常会有一些注释的规范,一次性写很多文件,就要把这部分内容复制来复制去,不太方便,因此就想着vscode是不是有什么插件可以用用,就发现了这样一个插件。

插件是这个,搜索koroFileHeader

image

这个安装完之后最好自己配一下,不然不是很符合

进入设置页面,搜索FileHeader,找到下面的一个json
image

点击会跳到这里,这个部分全都不要(是指fileheader的部分哈)
image

替换成下面的内容

    // 头部注释
    "fileheader.customMade": {
        "Author": "LX2035", // 创建文件的作者
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "OBKoro1", // 文件最后编辑者
        // 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致merge
        // 可以将时间颗粒度改为周、或者月,这样冲突就减少很多。搜索变更时间格式: dateFormat
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        // 输出相对路径,类似: /文件夹名称/src/index.js
        "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
        // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
        "Description": "", // 介绍文件的作用、文件的入参、出参。
        // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
        // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
        "custom_string_obkoro1": "",
        // 版权声明 保留文件所有权利 自动替换年份
        "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by LX2035, All Rights Reserved. "
    },
    // 函数注释
    "fileheader.cursorMode": {
        "description": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
    } 

效果如下:
image

之后新建一个文件,按下control + win + i,就是给文件加上头的注释,按下control + win + t就是给函数加注释,最终效果如下:

标签:文件,插件,string,vscode,custom,注释,edit
From: https://www.cnblogs.com/lx2035/p/18064366

相关文章

  • UnrealSharp: 一个可以让你在UnrealEngine5中采用C# 12和.NET 8.0开发的插件
    写着玩的,就当学习Unreal练手的玩意儿了。主要特性:支持.NET6.0~.NET8.0[默认为.NET8.0],支持C#12支持在C#中创建新的Unreal类、Unreal结构、Unreal枚举等支持为C#类创建新的Unreal属性、Unreal函数和Unreal多播委托。支持C#类继承UnrealC++类,这意味着您可以......
  • vscode编写python
    安装插件打开cmd创建虚拟环境C:\Users\ychen>condacreate-nenv_devpython=3.10.4Fetchingpackagemetadata.................Solvingpackagespecifications:.PackageplanforinstallationinenvironmentC:\ProgramData\Anaconda3\envs\env_dev:Thefo......
  • Python正则表达式的具体应用例子及注释
    lst=re.findall(r'\d+',"我的电话号是:10086,我女朋友的电话是:10010")print(lst)#finditer:匹配字符串中所有的内容【返回的是迭代器】,从迭代中拿内容,用“.group”num=re.finditer(r"\d+","我的电话号是:10086,我女朋友的电话是:10010")foriinnum:print(i)""......
  • mysql 5.7安装mariadb审计插件
    官方文档:https://mariadb.com/kb/en/mariadb-audit-plugin/参考文档:https://segmentfault.com/a/1190000042056617下载10.5版本的mariadb,再高的版本不适合5.7 1、下载mariadb下载界面:https://dlm.mariadb.com/browse/mariadb_server/101/1956/bintar-linux-x86_64/root......
  • vscode 远程连接设置免密登录
    一、找到windows下的秘钥文件,路径为C:\Users\wubin\.ssh二、上传到linux主机下,更改名字为“authorized_keys”,并更改权限。存放路径::~/.ssh$cat~/id_rsa.pub>>authorized_keyssudochmod600authorized_keys三、重启sshd服务即可。使用vscode再次连接即不需要输入密码......
  • vscode 两种定位跳转的方法 ctrl+p 方法1 path:行号 方法2 #变量名 - 针对$store变量
    vscode两种定位跳转的方法ctrl+p方法1path:行号方法2#变量名-针对$store变量不好找的方案方法1可以备注在代码里面问题$store的变量不能跳转,有跳转插件也不能跳转解决方案方法1备注上文件地址和行号,然后选择备注那行ctrl+cctrl+p回车不足的地方是代码变了,行号不......
  • vscode 的sync的问题RequestFailed (UserDataSyncError) syncResource:unknown operat
    024-03-0708:58:24.361[error]RequestFailed(UserDataSyncError)syncResource:unknownoperationId:unknown:Connectionrefusedfortherequest'https://vscode-sync.trafficmanager.net/v1/manifest'.atu.D(c:\Debug\VSCode\resources\app\ou......
  • IDEA自定义注释
    注释模板配置首先打开IDEA设置Settings...(Windows快捷键:Ctrl+Alt+S,Mac快捷键:command+,)--->Editor--->LiveTemplates--->点击右侧加号"+"设置以下六处相应的内容Abbreviation:快捷缩略词,可以输入数值、字母、符号,到时配合/*使用(依模板内容而定),例......
  • VSCode 发布时报error MSB4018: “CreateAppHost”任务意外失败
    大概率是杀毒软件问题,我的问题是有360杀毒导致的网上的方案有如下,也都进行了尝试:重启VisualStudio以管理员身份运行VisualStudio清理解决方案删除bin目录下的所有文件均无效,无奈之下继续寻找解决方案,发现用ProcessMonitor来监控到底是谁在搞鬼。通过下载ProcessMo......
  • vscode中如何对vue文件代码进行格式化
    vscode中如何对vue文件代码进行格式化1.通过vscode的Extensions插件市场,搜索Vetur插件。Vetur是一个专门为Vue开发提供支持的插件,它提供了代码高亮、智能提示、语法检查等功能2.找到vscode的设置Settings,然后在搜索栏中输入:“Editor:DefaultFormatter”,选择"Vetur"作为默认的......