VSCode多行註釋外掛KoroFileHeader使用範例

2023-03-23 22:03:43

1.簡介

VSCode外掛: 用於一鍵生成檔案頭部註釋並自動更新最後編輯人和編輯時間、函數註釋自動生成和引數提取。
外掛可以幫助使用者養成良好的編碼習慣，規範整個團隊風格。

主要功能

自動生成檔案頭部註釋，自動更新最後編輯人、最後編輯時間等。
一鍵生成函數註釋，支援函數引數自動提取並列到註釋中。
支援新增佛祖保佑永無bug、神獸護體、甩蔥少女等好玩有趣的影象註釋。
設定非常靈活方便，各種細節都能設定，可以量身打造適合你的註釋。
支援所有主流語言, 設定檔案非常詳細，齊全。

2.安裝

在 Vscode 擴充套件商店中搜尋koroFileHeader, 點選安裝。

3.使用

預設快捷鍵

檔案頭部註釋快捷鍵

window：ctrl+win+i,mac：ctrl+cmd+i, linux: ctrl+meta+i,Ubuntu: ctrl+super+i

函數註釋快捷鍵

window：ctrl+win+t,mac：ctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t

函數註釋遊標移動到下一行行尾，快速新增函數引數描述

window: win+y, mac: cmd+y, linux: meta+y

圖案註釋快捷鍵

隨機生成：window：ctrl+alt+j, mac：ctrl+cmd+j
精確選擇：快捷鍵Ctrl + P,輸入> codeDesign,選擇想要的圖案註釋

自定義快捷鍵

經常出現快捷鍵失靈的情況，這是由於VSCode快捷鍵衝突導致。這時需要我們自定義VSCode快捷鍵。

點選VSCode左下角管理圖示-->點選鍵盤快捷方式，或直接使用快捷鍵Ctrl + K Ctrl + S開啟鍵盤快捷方式修改視窗。

注意：修改快捷鍵前先檢視想要使用的快捷鍵是否被佔用。

一共四個快捷鍵需要設定，分別搜尋

頭部註釋：extension.fileheader
函數註釋：extension.cursorTip
遊標移動：koroFileheader.table
隨機圖案：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", 
        // 版權宣告 保留所有權利 自動替換年份
	"custom_string_obkoro1_copyright": "Copyright ${now_year} Marvin, All Rights Reserved. ",
	"custom_string_obkoro1_date": "Do not edit", // 版權時間
},
"fileheader.cursorMode": {
	//此為函數註釋
	"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, // 自動新增頭部註釋是否開啟，預設為true
	"autoAddLine": 100,
	"autoAlready": true,
	"annotationStr": {
		"head": "/*",
		"middle": " * @",
		"end": " */",
		"use": false
	},
	"headInsertLine": {
		"php": 2,
		"sh": 2
	},
	"beforeAnnotation": {
		"檔案字尾": "該檔案字尾的頭部註釋之前新增某些內容"
	},
	"afterAnnotation": {
		"檔案字尾": "該檔案字尾的頭部註釋之後新增某些內容"
	},
	"specialOptions": {
		"特殊欄位": "自定義比如LastEditTime/LastEditors"
	},
	"switch": {
		"newlineAddAnnotation": true
	},
	"supportAutoLanguage": [],
	"prohibitAutoAdd": ["json", "md"], // 禁止自動新增頭部註釋的檔案型別
	"folderBlacklist": ["node_modules", "資料夾禁止自動新增頭部註釋"],
	"prohibitItemAutoAdd": ["專案的全稱, 整個專案禁止自動新增頭部註釋, 可以使用快捷鍵新增"],
	"moveCursor": true,
	"dateFormat": "YYYY-MM-DD HH:mm:ss",
	"atSymbol": ["@", "@"],
	"atSymbolObj": {
		"檔案字尾": ["頭部註釋@符號", "函數註釋@符號"]
	},
	"colon": [": ", ": "],
	"colonObj": {
		"檔案字尾": ["頭部註釋冒號", "函數註釋冒號"]
	},
	"filePathColon": "路徑分隔符替換",
	"showErrorMessage": false,
	"writeLog": false,
	"wideSame": true,
	"wideNum": 13, // 頭部註釋自動對齊的寬度
	"functionWideNum": 15, // 函數註釋自動對齊寬度
	"CheckFileChange": true,
	"createHeader": true,
	"useWorker": false,
	"designAddHead": false,
	"headDesignName": "random", // 頭部圖案註釋，預設隨機
	"headDesign": false, // 預設關閉 開啟後,所有生成頭部註釋的場景都會生成圖案註釋
	"cursorModeInternalAll": {},
	"openFunctionParamsCheck": true,
	"functionParamsShape": ["{", "}"],
	"functionBlankSpaceAll": {},
	"functionTypeSymbol": " ", // 引數沒有型別時的預設值
	"typeParamOrder": "type param",
	"customHasHeadEnd": {},
	"throttleTime": 60000,
	"functionParamAddStr": "",
},

其他詳細設定可查閱官方GitHub

也可查閱C槽下的VSCode擴充套件原始碼。

以上就是VSCode多行註釋外掛KoroFileHeader使用範例的詳細內容，更多關於VSCode多行註釋KoroFileHeader的資料請關注it145.com其它相關文章！