VSCode多行注釋插件KoroFileHeader使用示例
1.簡介
- VSCode插件: 用于一鍵生成文件頭部注釋并自動(dòng)更新最后編輯人和編輯時(shí)間、函數(shù)注釋自動(dòng)生成和參數(shù)提取。
- 插件可以幫助用戶養(yǎng)成良好的編碼習(xí)慣,規(guī)范整個(gè)團(tuán)隊(duì)風(fēng)格。
主要功能
- 自動(dòng)生成文件頭部注釋,自動(dòng)更新最后編輯人、最后編輯時(shí)間等。
- 一鍵生成函數(shù)注釋,支持函數(shù)參數(shù)自動(dòng)提取并列到注釋中。
- 支持添加佛祖保佑永無bug、神獸護(hù)體、甩蔥少女等好玩有趣的圖像注釋。
- 配置非常靈活方便,各種細(xì)節(jié)都能配置,可以量身打造適合你的注釋。
- 支持所有主流語言, 配置文檔非常詳細(xì),齊全。
2.安裝
在 Vscode 擴(kuò)展商店中搜索koroFileHeader, 點(diǎn)擊安裝。
3.使用
默認(rèn)快捷鍵
文件頭部注釋快捷鍵
window:ctrl+win+i,mac:ctrl+cmd+i, linux: ctrl+meta+i,Ubuntu: ctrl+super+i
函數(shù)注釋快捷鍵
window:ctrl+win+t,mac:ctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t
函數(shù)注釋光標(biāo)移動(dòng)到下一行行尾,快速添加函數(shù)參數(shù)描述
window: win+y, mac: cmd+y, linux: meta+y
圖案注釋快捷鍵
- 隨機(jī)生成:
window:ctrl+alt+j,mac:ctrl+cmd+j - 精確選擇:快捷鍵
Ctrl + P,輸入> codeDesign,選擇想要的圖案注釋
自定義快捷鍵
經(jīng)常出現(xiàn)快捷鍵失靈的情況,這是由于VSCode快捷鍵沖突導(dǎo)致。這時(shí)需要我們自定義VSCode快捷鍵。
點(diǎn)擊VSCode左下角管理圖標(biāo)-->點(diǎn)擊鍵盤快捷方式,或直接使用快捷鍵Ctrl + K Ctrl + S打開鍵盤快捷方式修改窗口。
注意:修改快捷鍵前先查看想要使用的快捷鍵是否被占用。
一共四個(gè)快捷鍵需要設(shè)置,分別搜索
- 頭部注釋:
extension.fileheader - 函數(shù)注釋:
extension.cursorTip - 光標(biāo)移動(dòng):
koroFileheader.table - 隨機(jī)圖案:
extension.codeDesign
4.插件自定義配置
"fileheader.customMade": {
//此為頭部注釋
"Description": "",
"Version": "V1.0.0",
"Author":"git config user.name && git config user.email",
"Date": "Do not edit",
"LastEditors": "git config user.name && git config user.email",
"LastEditTime": "Do not edit",
"FilePath": "only file name",
// 版權(quán)聲明 保留所有權(quán)利 自動(dòng)替換年份
"custom_string_obkoro1_copyright": "Copyright ${now_year} Marvin, All Rights Reserved. ",
"custom_string_obkoro1_date": "Do not edit", // 版權(quán)時(shí)間
},
"fileheader.cursorMode": {
//此為函數(shù)注釋
"description": "",
"param": "",
"return": "",
"Date": "Do not edit",
"Author": "git config user.name && git config user.email",
"LastEditors": "git config user.name && git config user.email",
"LastEditTime": "Do not edit"
},
"fileheader.configObj": {
"createFileTime": false,
"language": {
"languagetest": {
"head": "/$$",
"middle": " $ @",
"end": " $/",
"functionSymbol": {
"head": "/** ",
"middle": " * @",
"end": " */"
},
"functionParams": "js"
}
},
"autoAdd": false, // 自動(dòng)添加頭部注釋是否開啟,默認(rèn)為true
"autoAddLine": 100,
"autoAlready": true,
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": false
},
"headInsertLine": {
"php": 2,
"sh": 2
},
"beforeAnnotation": {
"文件后綴": "該文件后綴的頭部注釋之前添加某些內(nèi)容"
},
"afterAnnotation": {
"文件后綴": "該文件后綴的頭部注釋之后添加某些內(nèi)容"
},
"specialOptions": {
"特殊字段": "自定義比如LastEditTime/LastEditors"
},
"switch": {
"newlineAddAnnotation": true
},
"supportAutoLanguage": [],
"prohibitAutoAdd": ["json", "md"], // 禁止自動(dòng)添加頭部注釋的文件類型
"folderBlacklist": ["node_modules", "文件夾禁止自動(dòng)添加頭部注釋"],
"prohibitItemAutoAdd": ["項(xiàng)目的全稱, 整個(gè)項(xiàng)目禁止自動(dòng)添加頭部注釋, 可以使用快捷鍵添加"],
"moveCursor": true,
"dateFormat": "YYYY-MM-DD HH:mm:ss",
"atSymbol": ["@", "@"],
"atSymbolObj": {
"文件后綴": ["頭部注釋@符號", "函數(shù)注釋@符號"]
},
"colon": [": ", ": "],
"colonObj": {
"文件后綴": ["頭部注釋冒號", "函數(shù)注釋冒號"]
},
"filePathColon": "路徑分隔符替換",
"showErrorMessage": false,
"writeLog": false,
"wideSame": true,
"wideNum": 13, // 頭部注釋自動(dòng)對齊的寬度
"functionWideNum": 15, // 函數(shù)注釋自動(dòng)對齊寬度
"CheckFileChange": true,
"createHeader": true,
"useWorker": false,
"designAddHead": false,
"headDesignName": "random", // 頭部圖案注釋,默認(rèn)隨機(jī)
"headDesign": false, // 默認(rèn)關(guān)閉 開啟后,所有生成頭部注釋的場景都會(huì)生成圖案注釋
"cursorModeInternalAll": {},
"openFunctionParamsCheck": true,
"functionParamsShape": ["{", "}"],
"functionBlankSpaceAll": {},
"functionTypeSymbol": " ", // 參數(shù)沒有類型時(shí)的默認(rèn)值
"typeParamOrder": "type param",
"customHasHeadEnd": {},
"throttleTime": 60000,
"functionParamAddStr": "",
},也可查閱C盤下的VSCode擴(kuò)展源碼。
以上就是VSCode多行注釋插件KoroFileHeader使用示例的詳細(xì)內(nèi)容,更多關(guān)于VSCode多行注釋KoroFileHeader的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
微信小程序getPhoneNumber獲取用戶手機(jī)號
這篇文章主要介紹了 微信小程序getPhoneNumber獲取用戶手機(jī)號的相關(guān)資料,希望通過本文能幫助到大家,需要的朋友可以參考下2017-09-09
自行實(shí)現(xiàn)Promise.allSettled的Polyfill處理
這篇文章主要為大家介紹了自行實(shí)現(xiàn)Promise.allSettled?的?Polyfill處理示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-08-08
微信小程序中實(shí)現(xiàn)一對多發(fā)消息詳解及實(shí)例代碼
這篇文章主要介紹了微信小程序中實(shí)現(xiàn)一對多發(fā)消息詳解及實(shí)例代碼的相關(guān)資料,需要的朋友可以參考下2017-02-02
關(guān)于Javascript閉包與應(yīng)用的詳解
這篇文章主要介紹了關(guān)于Javascript閉包與應(yīng)用的詳解,文中有非常詳細(xì)的代碼示例.對正在學(xué)習(xí)js的伙伴們有很好的幫助,需要的朋友可以參考下2021-04-04
JavaScript監(jiān)測數(shù)據(jù)類型方法全面總結(jié)
這篇文章主要為大家介紹了JavaScript監(jiān)測數(shù)據(jù)類型方法示例全面總結(jié),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-08-08
微信小程序 商城開發(fā)(ecshop )簡單實(shí)例
這篇文章主要介紹了微信小程序 商城開發(fā)(ecshop )簡單實(shí)例的相關(guān)資料,需要的朋友可以參考下2017-04-04

