VsCode插件自动生成注释插件koroFileHeader使用教程

目录
  • VsCode插件自动生成注释插件koroFileHeader使用
  • PS：vscode使用‘koroFileHeader‘插件生成注释
    • 插件安装
    • 配置插件
    • 插件使用
    • 生成图案注释

VsCode插件自动生成注释插件koroFileHeader使用

强烈推荐的一款VsCode注释插件koroFileHeader，具体使用参考内容。

1、安装插件。

在VsCode里选择Extensions搜索koroFileheader进行安装。

2、根据需要修改默认注释配置，先选择File-Preferences-Settings，搜索fileheader在setting.json里根据需求自行配置注释的风格。具体可配置字段我简单配置下可满足基本注释例如（直接加载setting.json里即可）

    "fileheader.customMade": { //此为头部注释
        "Description": "", // 文件描述
        "Version": "2.0", // 版本
        "Author": "wuyue.nan", // 文件作者
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "wuyue.nan", // 文件最后编辑者
        "LastEditTime": "Do not edit" // 文件最后编辑时间
    },
    "fileheader.cursorMode": { //此为函数注释
        "description":"", // 功能描述
        "param": "", // 传入参数
        "return": "", // 返回结果
        "author":"wuyue.nan" // 函数作者
    }

3、使用：在vue文件中，使用快捷键可以看到自己设置注释内容。
Ctrl + Win+i 文件头部注释快捷键

<!--
 * @Author: wuyue.nan
 * @Description:
 * @Date: 2022-04-01 09:08:22
 * @LastEditors: wuyue.nan
 * @LastEditTime: 2022-04-01 10:44:20
-->

Ctrl + Win+ t 函数注释

 /**
  * @description
  * @author wuyue.nan
  * @param {*}
  * @return {*}
  */

PS：vscode使用‘koroFileHeader‘插件生成注释

插件安装

1.打开vscode，搜索“koroFileHeader”并安装。

2.安装完成后重启vscode

配置插件

1.文件 > 首选项 > 设置 > 扩展 > File Header Configuration

2.在setting.json新增如下配置：

// 头部注释
"fileheader.customMade": {
    "Author": "your Name", // 创建人
    "Date": "Do not edit", // 创建时间
    "LastEditors": "your Name", // 最后一次编辑人
    "LastEditTime": "Do not edit", // 最后一次编辑时间
    "Description": "", // 文件描述 手动编辑
    "autoAdd": true // 自动生成头部的注释
},
// 函数注释
"fileheader.cursorMode": {
    "description": "", // 函数功能描述 手动编辑
    "param": "", // 参数 手动编辑
    "return": "", // 返回值 手动编辑
    "author": "your Name" // 创建人
}

插件使用

头部注释：在当前编辑文件中使用快捷键即可生成文件头部注释。

window系统快捷键：Ctrl+Alt+i

函数注释：将光标放在函数行或者将光标放在函数上方的空白行,使用快捷键即可生成函数注释。

window系统快捷键：Ctrl+Alt+t

生成图案注释

使用Ctrl + Shift + p快捷键, 输入"codedesign" ，选择图案

到此这篇关于VsCode插件自动生成注释插件koroFileHeader使用的文章就介绍到这了,更多相关VsCode自动生成注释插件koroFileHeader使用内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • vscode ssh远程连接服务器的思考浅析

    目录 过往经验总结 关于vscode 与ssh有关的两个配置文件 报错解决:ssh连接时提示管道不存在 问题 解决方案 方案一:使用git中的ssh作为替代 方案二:修改私钥文件权限 各方式远程连接项目文件的性能对比 现象 原因分析 过往经验总结 注:笔者写本文的目的不是完整细致地描述连接的全过程,而是记录当中遇到的现象.问题,及为什么会产生这个问题的分析.所以部分过程会省略,或者默认读者都是很熟悉各种操作的. 使用ssh远程连接,要获知目标主机的ip地址,并使用正确的密码或密钥. 笔者之前曾尝

  • vscode不支持nvue语法高亮的解决办法(图文详解)

    目录 项目场景: 问题描述 原因分析: 解决方案: 配置如图 解决效果 项目场景: 项目场景:用vscode开发uniapp会遇到用.nvue开发的时候.但是vscode并没有提供.nvue的语法高亮,这篇文章给刚用vscode写.nvue的读者 问题描述 例如:vscode中使用*.nvue识别不出文件类型,没有语法高亮如图: 原因分析: 我这里用的插件是vue3语法支持的Volar,网上铺天盖地的vetur解决方案,其实只要vscode配置一下就行 解决方案: 配置如图 解决效果 到此这篇关

  • VSCode多行注释插件KoroFileHeader使用示例

    目录 1.简介 主要功能 2.安装 3.使用 默认快捷键 文件头部注释快捷键 函数注释快捷键 图案注释快捷键 自定义快捷键 4.插件自定义配置 1.简介 VSCode插件: 用于一键生成文件头部注释并自动更新最后编辑人和编辑时间.函数注释自动生成和参数提取. 插件可以帮助用户养成良好的编码习惯,规范整个团队风格. 主要功能 自动生成文件头部注释,自动更新最后编辑人.最后编辑时间等. 一键生成函数注释,支持函数参数自动提取并列到注释中. 支持添加佛祖保佑永无bug.神兽护体.甩葱少女等好玩有趣的图

  • VSCode中 Eslint 和 Prettier 冲突问题最新解决方法

    目录 前言 为什么会冲突 Eslint Prettier 冲突 解决 前言 本次环境皆为 @vue/cli默认安装带有的 eslint@7.32.0,VSCode 插件版本: Eslint v2.4.0 Prettier v9.10.4 为什么会冲突 首先我们需要知道为什么使用Eslint 和 Prettier,下面先介绍两者的单独用法 Eslint Javascript Vue Typescript 等文件的代码规范检测工具,当代码写法不符合时,会在终端进行报错提醒,阻止你的serve服务.为

  • VsCode插件自动生成注释插件koroFileHeader使用教程

    目录 VsCode插件自动生成注释插件koroFileHeader使用 PS:vscode使用‘koroFileHeader‘插件生成注释 插件安装 配置插件 插件使用 生成图案注释 VsCode插件自动生成注释插件koroFileHeader使用 强烈推荐的一款VsCode注释插件koroFileHeader,具体使用参考内容. 1.安装插件. 在VsCode里选择Extensions搜索koroFileheader进行安装. 2.根据需要修改默认注释配置,先选择File-Preference

  • springboot集成mybatis-maven插件自动生成pojo的详细教程

    springboot集成mybatis-maven插件自动生成pojo的详细教程

    1.生成springboot项目,选择mybatis.mysql(略过) 2.搭建mysql环境,打开服务,记录用户名及密码,新建业务表. 3.在resources文件夹下新建如图所示文件夹: 4.包路径配置(记住自己存放的路径,后面用): 5.在generator中新建文件generatorConfig.properties(统一存放需要的变量).generatorMapper.xml 6.generatorConfig.properties内容如下,(mysql的jdbc.url一定要加时区

  • 使用 webpack 插件自动生成 vue 路由文件的方法

    一款自动生成 vue 路由文件的 webpack 插件 vue-route-webpack-plugin在项目中试点成功了,现在在项目中已经不需要再维护路由配置文件了,由插件自动生成,节省了大家维护路由的时间. 从长远来看,使用插件自动生成路由是具有一定好处的.当项目中的路由配置非常多的时候,为了区分业务,你可能需要分成许多个文件来存放这些路由文件,这样就不得不去维护这些路由文件. 比如这样的路由文件结构: |-src/ |-router/ index.js childrenRouter.js

  • 利用json2POJO with Lombok 插件自动生成java类的操作

    利用json2POJO with Lombok 插件自动生成java类的操作

    前言 很多时候,我们定义接口或者调用别人的接口时,手里只有一份接口文档,文档中提供一段示例json格式的报文,我们需要根据json中的字段,挨个去定义java POJO 的字段属性. 属实费劲,且有时候万一手抖,个别字段填错了,就导致前后端联调不能一次性成功. 如果能有办法将json直接生成java POJO,岂不是能省去很多时间. 1.安装idea 插件 打开preferences → Plugins → marketplace → 输入:json2Pojo with Lombok,点击安装并

  • Django 自动生成api接口文档教程

    最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化测试 环境 Python3.6 ,PyCharm,W7 项目结构 功能实现 流程 我们要做的就是实现以上流程 安装 pip install djangorestframework pip install markdown pip install django-filter # Filtering s

  • 使用Python 自动生成 Word 文档的教程

    当然要用第三方库啦 :) 使用以下命令安装: pip install python-docx 使用该库的基本步骤为: 1.建立一个文档对象(可自动使用默认模板建立,也可以使用已有文件). 2.设置文档的格式(默认字体.页面边距等). 3.在文档对象中加入段落文本.表格.图像等,并指定其样式. 4.保存文档. 注:本库仅支持生成Word2007以后版本的文档类型,即扩展名为.docx 的. 下面分步介绍其基本使用方法: 步骤一: from docx import Document doc = Do

  • Mybatis generator自动生成代码插件实例解析

    mybatis自动生成代码(实体类.Dao接口等)是很成熟的了,就是使用mybatis-generator插件. 它是一个开源的插件,使用maven构建最好,可以很方便的执行 插件官方简介: http://www.mybatis.org/generator/index.html 插件的GitHub地址: https://github.com/mybatis/generator 如何使用mybatis-generator插件呢?只需要三步: 1.修改pom.xml配置文件 网上大部分说法都要添加依

  • IntelliJ IDEA修改新建文件自动生成注释的user名

    IntelliJ IDEA修改新建文件自动生成注释的user名

    想要在IntelliJ IDEA编辑器里面修改,新建Class文件或者jsp文件或者js文件时候 文件头自带的 Created by {User} on ${DATE}. 一般在新建的时候,user默认取的是电脑的主机名,这个不是我们想要的.可以如下图修改. 如果还有什么类型,没提到的,自己找找自己要用的就可以啦.一个道理. 说明一下: 可以分别点击class,interface,enum,等等,可以看到右边的编辑框里面都有一个#parse("file header.java") 这个

  • IDEA MyBatis Plugins自动生成实体类和mapper.xml

    前言 如何下载和使用MyBatis Generator 插件,只说代码,不讲感情.如果有问题还请多多指点. 开发环境 开发工具:IntelliJ IDEA 2018.1.1 x64 dk版本:1.8.0_171 工程构建工具:maven 版本3.2.5 数据库 mysql IDEA 下载MyBatis Generator 插件 1.首先在File--Settings--点击Plugins,搜索框中搜索mybatis,选择mybatis-plugins,点击安装(由于我的已经安装过,所以没有绿色的

  • 使用mybatis-plus-generator进行代码自动生成的方法

    为了解放程序员的双手,减少重复性代码的编写,推荐使用插件:mybatis-plus-generator 进行代码自动生成.下面我将详细介绍通过mybatis-plus-generator 插件自动生成 controller.service.mapper.serviceImpl相关代码. 项目工程目录总览如下: 1. 使用 idea 创建 maven 项目,引入相关依赖,项目pom文件如下所示: <?xml version="1.0" encoding="UTF-8&qu

随机推荐