在VScode中,文件自动添加头部注释-插件koroFileHeader配置

这篇具有很好参考价值的文章主要介绍了在VScode中,文件自动添加头部注释-插件koroFileHeader配置。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

korofileheader插件是用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。

  1. 首先打开VScode,进入扩展商店,搜索koroFileHeader进行安装

vscode自动注释插件,vscode,Powered by 金山文档
  1. 打开设置-搜索Fileheader-点击头部注释的setting.json文件

vscode自动注释插件,vscode,Powered by 金山文档
  1. 可以在其中配置头部注释

  "fileheader.customMade": {
    "Author": "HLei", //作者
    "Date": "Do not edit", //文件生成时间
    "email": "******@163.com", //邮箱
    "github": "https://github.com/****", // github地址
    "LastEditors": "HLei", //最后更改人
    "LastEditTime": "Do not edit", // 最后编辑时间
    "Description": "" // 描述
  }

其中作者和邮箱可以从git中获取,动态配置

  "fileheader.customMade": {
    "Author": "git config user.name", //作者
    // "Author": "git config user.name", // 可以获取git用户名
    // "Author": "HLei", // 写死的固定值 不从git config中获取
    "email": “git config user.email”, //邮箱
    // "email": "git config user.email", // 可以获取git邮箱    
    // "email": "******@163.com", // 写死的固定值 不从git config中获取
  }
  1. 设置完后,打开文件使用快捷键Ctrl+Alt+i,自动生成头部注释,效果图如下:

vscode自动注释插件,vscode,Powered by 金山文档

拓展:

  1. 如果快捷键Ctrl+Alt+i失效,打开键盘快捷键方式,搜索fileheader,查看快捷键命令是不是Ctrl+Alt+i,

vscode自动注释插件,vscode,Powered by 金山文档
  1. 如果不是可以双击键绑定,修改自己想设置的快捷键(注意一定不要和已存的快捷键冲突)

vscode自动注释插件,vscode,Powered by 金山文档
  1. 可以设置新增文件,自动添加文件头部注释,建议设置false,自己手动设置需要添加头部注释的文件更好文章来源地址https://www.toymoban.com/news/detail-606736.html

"fileheader.configObj": {
    "autoAdd": false, // 检测文件没有头部注释,自动添加文件头部注释
  },

到了这里,关于在VScode中,文件自动添加头部注释-插件koroFileHeader配置的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【vscode】生成函数参数@param注释 及 自动添加头注释和函数注释

    自动添加头部、函数注释 方法一:输入/**,IDE会自动弹出完整的多行注释demo: 方法二:下载安装koroFileHeader, 一个vscode插件, 用于生成文件头部注释和函数注释的插件,效果如下: 用户设置文件settings.json,输入以下配置: 配置完成保存后, 重启vscode 完成插件环境生成。

    2024年02月13日
    浏览(58)
  • 最新的Microsoft Visual Studio新建文件自动添加注释教程

    提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 目录 前言 一、注释是什么? 二、自动添加头部注释 1.添加注释教程 第一步:找到VS安装的路径,忘记了就点击VS图标,右键属性找到起始位置。  第二步:在安装路径下继续往下找一个叫Class.cs的文件

    2024年02月04日
    浏览(82)
  • 【工具】vscode的常用插件之注释插件

    🐚作者简介:花神庙码农(专注于Linux、WLAN、TCP/IP、Python等技术方向) 🐳博客主页:花神庙码农 ,地址:https://blog.csdn.net/qxhgd 🌐系列专栏:善假于物 📰如觉得博主文章写的不错或对你有所帮助的话,还望大家三连支持一下呀!!! 👉关注✨、点赞👍、收藏📂、评论。

    2024年02月05日
    浏览(55)
  • 实现一个vscode插件:打开多个vscode项目时根据.nvmrc文件自动切换nvm

    开发背景与最终功能 需要维护一些老项目,同时开发新项目时,切换nvm很烦人 最终实现vscode插件:每个vscode实例打开一个项目,切换vscode实例时能自动切换版本(需要项目根目录有一个.nvmrc文件) 插件下载 vscode插件市场搜索 vscode-nvmrc 设计思路 项目根目录新建 .nvmrc 文件,

    2024年02月15日
    浏览(40)
  • Goland 注释时自动在注释符号后添加空格

    不得不说 JetBrains 旗下的 IDE 都好用,而且对于注释这块,使用 Ctrl + / 进行注释的时候,大多会在每个注释符号后统一添加一个空格,比如 PyCharm 和 RubeMine 等。 但最近终于碰到了一个例外,那就是 GoLand,你进行行注释的时候,它默认是不会加空格的,就像下边这种(至于它

    2024年02月12日
    浏览(39)
  • VSCode中自动生成文档头注释和函数注释

    在编写python代码的时候,有时候需要对函数的作用、参数以及返回值进行说明,如下图所示,自己编写的话会有很多重复操作,于是希望可以使用快捷键自己生成,下面进行具体步骤的讲解。 打开VSCode,在扩展中搜索koroFileHeader,进行安装 1.在VSCode中打开设置 2.在设置中添加

    2024年02月08日
    浏览(55)
  • vscode markdown preview enhanced插件显示图片alt标题注释

    vscode markdown preview enhanced plugin show image alt title description edit parser.js file‘s onWillParseMarkdown OR onDidParseMarkdown function: windows:%userprofile%/.crossnote/parser.js linux/mac:~/.crossnote/parser.js for old version: windows:%userprofile%/.mume/parser.js linux/mac:~/.mume/parser.js

    2024年02月09日
    浏览(45)
  • Pycharm工具Python开发自动添加注释(详细)

    定义了一个函数,在函数下面敲入了三个双引号后,enter回车并没有自动出现注释,如图: 解决办法 Pycharm中依次打开File — Settings — Tools — Python Integrated Tools,如图: 成功

    2024年02月15日
    浏览(52)
  • 【Java】源码文件开头添加注释

    应公司质量部要求,需要对代码做静态检查。质量部要求,源码文件必须在起始行起设置一些注释,然而项目已经开发了一年之久,且没有维护这个注释。 此时,面对好几千个源码文件,我们如何快速添加相应的注释呢? 对,自己写一个程序来实现。 假设注释模板为 只要获

    2024年01月17日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包