VsCode插件自動生成注釋插件koroFileHeader使用教程

更新時間：2023年01月17日 09:58:21 作者：無月大大

這篇文章主要介紹了VsCode插件自動生成注釋插件koroFileHeader使用教程,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

VsCode插件自動生成注釋插件koroFileHeader使用

強烈推薦的一款VsCode注釋插件koroFileHeader，具體使用參考內(nèi)容。

1、安裝插件。

在VsCode里選擇Extensions搜索koroFileheader進行安裝。

在這里插入圖片描述

2、根據(jù)需要修改默認(rèn)注釋配置，先選擇File-Preferences-Settings，搜索fileheader在setting.json里根據(jù)需求自行配置注釋的風(fēng)格。具體可配置字段我簡單配置下可滿足基本注釋例如（直接加載setting.json里即可）

    "fileheader.customMade": { //此為頭部注釋
        "Description": "", // 文件描述
        "Version": "2.0", // 版本
        "Author": "wuyue.nan", // 文件作者
        "Date": "Do not edit", // 文件創(chuàng)建時間(不變)
        "LastEditors": "wuyue.nan", // 文件最后編輯者
        "LastEditTime": "Do not edit" // 文件最后編輯時間
    },
    "fileheader.cursorMode": { //此為函數(shù)注釋
        "description":"", // 功能描述
        "param": "", // 傳入?yún)?shù)
        "return": "", // 返回結(jié)果
        "author":"wuyue.nan" // 函數(shù)作者
    }

3、使用：在vue文件中，使用快捷鍵可以看到自己設(shè)置注釋內(nèi)容。
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 函數(shù)注釋

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

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

插件安裝

1.打開vscode，搜索“koroFileHeader”并安裝。

2.安裝完成后重啟vscode

配置插件

1.文件 > 首選項 > 設(shè)置 > 擴展 > File Header Configuration

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

// 頭部注釋
"fileheader.customMade": {
    "Author": "your Name", // 創(chuàng)建人
    "Date": "Do not edit", // 創(chuàng)建時間
    "LastEditors": "your Name", // 最后一次編輯人
    "LastEditTime": "Do not edit", // 最后一次編輯時間
    "Description": "", // 文件描述 手動編輯
    "autoAdd": true // 自動生成頭部的注釋
},
// 函數(shù)注釋
"fileheader.cursorMode": {
    "description": "", // 函數(shù)功能描述 手動編輯
    "param": "", // 參數(shù) 手動編輯
    "return": "", // 返回值 手動編輯
    "author": "your Name" // 創(chuàng)建人
}

插件使用

頭部注釋：在當(dāng)前編輯文件中使用快捷鍵即可生成文件頭部注釋。

window系統(tǒng)快捷鍵：Ctrl+Alt+i

函數(shù)注釋：將光標(biāo)放在函數(shù)行或者將光標(biāo)放在函數(shù)上方的空白行,使用快捷鍵即可生成函數(shù)注釋。

window系統(tǒng)快捷鍵：Ctrl+Alt+t

生成圖案注釋

使用Ctrl + Shift + p快捷鍵, 輸入"codedesign" ，選擇圖案

到此這篇關(guān)于VsCode插件自動生成注釋插件koroFileHeader使用的文章就介紹到這了,更多相關(guān)VsCode自動生成注釋插件koroFileHeader使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: