VsCode插件自動(dòng)生成注釋插件koroFileHeader使用教程
VsCode插件自動(dòng)生成注釋插件koroFileHeader使用
強(qiáng)烈推薦的一款VsCode注釋插件koroFileHeader，具體使用參考內(nèi)容。
1、安裝插件。
在VsCode里選擇Extensions搜索koroFileheader進(jìn)行安裝。
2、根據(jù)需要修改默認(rèn)注釋配置，先選擇File-Preferences-Settings，搜索fileheader在setting.json里根據(jù)需求自行配置注釋的風(fēng)格。具體可配置字段我簡(jiǎn)單配置下可滿足基本注釋例如（直接加載setting.json里即可）
"fileheader.customMade": { //此為頭部注釋
"Description": "", // 文件描述
"Version": "2.0", // 版本
"Author": "wuyue.nan", // 文件作者
"Date": "Do not edit", // 文件創(chuàng)建時(shí)間(不變)
"LastEditors": "wuyue.nan", // 文件最后編輯者
"LastEditTime": "Do not edit" // 文件最后編輯時(shí)間
},
"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.打開(kāi)vscode，搜索“koroFileHeader”并安裝。
2.安裝完成后重啟vscode
配置插件
1.文件 > 首選項(xiàng) > 設(shè)置 > 擴(kuò)展 > File Header Configuration
2.在setting.json新增如下配置：
// 頭部注釋
"fileheader.customMade": {
"Author": "your Name", // 創(chuàng)建人
"Date": "Do not edit", // 創(chuàng)建時(shí)間
"LastEditors": "your Name", // 最后一次編輯人
"LastEditTime": "Do not edit", // 最后一次編輯時(shí)間
"Description": "", // 文件描述 手動(dòng)編輯
"autoAdd": true // 自動(dòng)生成頭部的注釋
},
// 函數(shù)注釋
"fileheader.cursorMode": {
"description": "", // 函數(shù)功能描述 手動(dòng)編輯
"param": "", // 參數(shù) 手動(dòng)編輯
"return": "", // 返回值 手動(dòng)編輯
"author": "your Name" // 創(chuàng)建人
}插件使用
頭部注釋?zhuān)?/strong>在當(dāng)前編輯文件中使用快捷鍵即可生成文件頭部注釋。
window系統(tǒng)快捷鍵：Ctrl+Alt+i
函數(shù)注釋?zhuān)?/strong>將光標(biāo)放在函數(shù)行或者將光標(biāo)放在函數(shù)上方的空白行,使用快捷鍵即可生成函數(shù)注釋。
window系統(tǒng)快捷鍵：Ctrl+Alt+t
生成圖案注釋
使用Ctrl + Shift + p快捷鍵, 輸入"codedesign" ，選擇圖案
到此這篇關(guān)于VsCode插件自動(dòng)生成注釋插件koroFileHeader使用的文章就介紹到這了,更多相關(guān)VsCode自動(dòng)生成注釋插件koroFileHeader使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了高性能JavaScript 重排與重繪,需要的朋友可以參考下2015-08-08
Axios設(shè)置token請(qǐng)求頭的三種方式
用戶登錄時(shí),后端會(huì)返回一個(gè)token,并且保存到瀏覽器的localstorage中,可以根據(jù)localstorage中的token判斷用戶是否登錄,所以當(dāng)發(fā)送請(qǐng)求時(shí),都要攜帶token給后端進(jìn)行判斷,本文給大家介紹了Axios設(shè)置token請(qǐng)求頭的三種方式,需要的朋友可以參考下2024-02-02
原創(chuàng)JS分欄效果，面向?qū)ο螅?使用簡(jiǎn)單。2009-08-08
深入理解js generator數(shù)據(jù)類(lèi)型
下面小編就為大家?guī)?lái)一篇深入理解js generator數(shù)據(jù)類(lèi)型。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-08-08
禁止js文件緩存問(wèn)題是我一直遇到的大問(wèn)題，終于找到了一個(gè)比較好的辦法2010-04-04
javascript 獲取頁(yè)面的高度及滾動(dòng)條的位置的代碼
javascript獲取頁(yè)面的高度及滾動(dòng)條的位置的代碼，需要的朋友可以參考下。2010-05-05
這篇文章主要為大家詳細(xì)介紹一下JavaScript中的作用域鏈與閉包的使用，文中的示例代碼講解詳細(xì)，對(duì)我們學(xué)習(xí)JavaScript有一定的幫助，需要的可以參考一下2022-11-11
uni-app?微信小程序授權(quán)登錄的實(shí)現(xiàn)步驟
本文主要介紹了uni-app?微信小程序授權(quán)登錄的實(shí)現(xiàn)步驟，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01
如何用js控制frame的隱藏或顯示的解決辦法，需要的朋友可以參考一下2013-03-03
js實(shí)現(xiàn)帶關(guān)閉按鈕始終顯示在網(wǎng)頁(yè)最底部工具條的方法
這篇文章主要介紹了js實(shí)現(xiàn)帶關(guān)閉按鈕始終顯示在網(wǎng)頁(yè)最底部工具條的方法,是非常實(shí)用的javascript固定效果,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-03-03