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

 更新时间:2023年01月17日 09:58:21   作者:无月大大  
这篇文章主要介绍了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使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • js调用刷新界面的几种方式

    js调用刷新界面的几种方式

    这篇文章主要为大家详细介绍了js调用刷新界面的几种方式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • IE6-IE9使用JSON、table.innerHTML所引发的问题

    IE6-IE9使用JSON、table.innerHTML所引发的问题

    这篇文章主要介绍了IE6-IE9使用JSON、table.innerHTML所引发的问题 ,需要的朋友可以参考下
    2015-12-12
  • js实现图片跟随鼠标移动效果

    js实现图片跟随鼠标移动效果

    这篇文章主要为大家详细介绍了js实现图片跟随鼠标移动效果,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-10-10
  • JS中offset和匀速动画详解

    JS中offset和匀速动画详解

    这篇文章主要介绍了JavaScript动画:offset和匀速动画详解(含轮播图的实现),并把实现代码做了分享,有兴趣的朋友参考下。
    2018-02-02
  • javascript foreach中如何获取数组下标/index

    javascript foreach中如何获取数组下标/index

    这篇文章主要介绍了javascript foreach中如何获取数组下标/index问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • JS中的算法与数据结构之列表(List)实例详解

    JS中的算法与数据结构之列表(List)实例详解

    这篇文章主要介绍了JS中的算法与数据结构之列表(List),结合实例形式分析了javascript列表的概念、原理以及定义、添加、删除、查找等相关操作技巧,需要的朋友可以参考下
    2019-08-08
  • 12行javascript代码绘制一个八卦图

    12行javascript代码绘制一个八卦图

    本文给大家分享的是使用有限的代码绘制八卦图,算是考核下自己对于javascript的理解,这里推荐给大家,有需要的小伙伴参考下。
    2015-04-04
  • js限制文本框只能输入中文的方法

    js限制文本框只能输入中文的方法

    这篇文章主要介绍了js限制文本框只能输入中文的方法,涉及javascript正则匹配及鼠标事件的相关技巧,非常简单实用,需要的朋友可以参考下
    2015-08-08
  • JavaScript+Canvas模拟实现支付宝画年兔游戏

    JavaScript+Canvas模拟实现支付宝画年兔游戏

    接近过年了,支付宝的集福的活动又开始了,集美们的五福集齐了没有。每年的集福活动都有一些小游戏,今年也不例外,画年画就是其中之一,本篇用canvas来写一个画年兔的游戏
    2023-01-01
  • JS实现容器模块左右拖动效果

    JS实现容器模块左右拖动效果

    这篇文章主要为大家详细介绍了JS实现容器模块左右拖动效果,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-01-01

最新评论