使用VSCode創(chuàng)建自定義注釋及代碼段的方法
1.打開VSCode活動欄中的管理面版
2.點(diǎn)擊配置用戶用戶代碼片段。如下圖所示
3.點(diǎn)擊新建全局代碼片段文件
4.輸入代碼段文件名，如需注釋c語言的代碼，則文件命名為c.json
5.以c語言為例，建立的文件默認(rèn)模板如下：
// "Print to console": {
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
其中"Print to console"為添加代碼段的說明。
"prefix"為調(diào)用這個代碼段的快捷輸入，如這里為log，則在VSCode編輯c語言的文本區(qū)輸入log則可以快速插入"body"里的內(nèi)容
“body”為代碼段的內(nèi)容，代碼每行之間以”,“號分割
”description“為代碼段的描述
6.創(chuàng)建一個main文件的頭部注釋模板(包含佛祖保佑，永無bug)：
"Create a new c main file": {
"prefix": "..file.main",
"body":
[
"/*********************************** Copyright (c) ************************************",
" ",
" _ooOoo_ ",
" o8888888o ",
" 88\" . \"88 ",
" (| -_- |) ",
" O\\ = /O ",
" ____/`---'\\____ ",
" .' \\\\\\\\| |\\\\\\\\ `. ",
" / \\\\\\\\||| : |||// \\ ",
" / _||||| -:- |||||- \\ ",
" | | \\\\\\\\\\\\ - /// | | ",
" | \\_| ''\\---/'' | | ",
" \\ .-\\__ `-` ___/-. / ",
" ___`. .' /--.--\\ `. . __ ",
" .\"\" '< `.___\\_<|>_/___.' >'\"\". ",
" | | : `- \\`.;`\\ _ /`;.`/ - ` : | | ",
" \\ \\ `-. \\_ __\\ /__ _/ .-` / / ",
" ======`-.____`-.___\\_____/___.-`____.-'====== ",
" `=---=' ",
" ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ",
" 佛祖保佑 永無BUG ",
" ",
"** It's all a circle,Everything gets a return. ",
"**---------------------------------File Info-------------------------------------------",
"** @file: ${TM_FILENAME}",
"** @author: $1${author.body}",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
"** @version: V0.0",
"** @brief: $2",
"** ",
"**-------------------------------------------------------------------------------------",
"** @modified: $3 ",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE ",
"** @version: V0.0 ",
"** @description: $4",
"** @note: $5",
"**-------------------------------------------------------------------------------------",
"** @copyright: $6",
"**************************************************************************************/",
],
"description": "a mainnote mode"
},
其中， T M F I L E N A M E 為當(dāng)前 c 源文件的文件名，這里如果為 m a i n . c , 則 {TM_FILENAME}為當(dāng)前c源文件的文件名，這里如果為main.c,則 TMF?ILENAME為當(dāng)前c源文件的文件名，這里如果為main.c,則{TM_FILENAME}會被替換為main.c
$1， $2為制表符的切換標(biāo)志，通過按下tab鍵，可從$1的位置快捷跳到$2的位置
$CURRENT_YEAR為當(dāng)前年份
$CURRENT_MONTH為當(dāng)前月份
$CURRENT_DATE為當(dāng)前日期
7.創(chuàng)建一個源文件的頭部注釋模板
"Create a new c source file": {
"prefix": "..file.c",
"isFileTemplate": true,
"body":
[
"/******************************** Copyright (c) ***************************************",
"**",
"**",
"**",
"**---------------------------------File Info-------------------------------------------",
"** @file: ${TM_FILENAME} ",
"** @author: $1${author.body} ",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE ",
"** @version: V0.0 ",
"** @brief: $2",
"** ",
"**-------------------------------------------------------------------------------------",
"** @modified: $3 ",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE ",
"** @version: V0.0 ",
"** @description: $2",
"** @note: $3",
"**-------------------------------------------------------------------------------------",
"** @copyright: $4",
"**************************************************************************************/",
],
"description": "a file.c mode"
},
8.創(chuàng)建一個頭文件的頭部注釋模板
"Create a new c header file": {
"prefix": "..file.h",
"isFileTemplate": true,
"body":
[
"/******************************** Copyright (c) ***************************************",
"**",
"**",
"**",
"**---------------------------------File Info-------------------------------------------",
"** @file: ${TM_FILENAME} ",
"** @author: $2${author.body} ",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE ",
"** @version: V0.0 ",
"** @brief: $3",
"** ",
"**-------------------------------------------------------------------------------------",
"** @modified: $4 ",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE ",
"** @version: V0.0 ",
"** @description: $5",
"** @note: $6",
"**-------------------------------------------------------------------------------------",
"** @copyright: $7",
"**************************************************************************************/",
"#ifndef __${1:${TM_FILENAME/(.*)\\.h$/${1:/upcase}_H/i}}",
"#define __$1",
"\n\n\n\n",
"/***************************************************************************************",
"** 接口數(shù)據(jù)申明",
"**************************************************************************************/\n",
"\n\n",
"/***************************************************************************************",
"** 接口函數(shù)申明",
"**************************************************************************************/\n",
"\n\n",
"#endif\t // __$1 \n",
"/***************************************************************************************",
"** End Of File",
"** 在燒寫的時(shí)候是FLASH中的被占用的空間為: Code + RO-data + RW-data",
"** 程序運(yùn)行的時(shí)候，芯片內(nèi)部RAM使用的空間為: RW-data + ZI-data",
"**************************************************************************************/\n",
],
"description": "a file.h mode"
},
9.創(chuàng)建一個新函數(shù)模板
"Create a new func": {
"prefix": "..func.new",
"body":
[
"void ${TM_FILENAME_BASE/(.*)/${1:/upcase}/}_Func(void)",
"{\n\n\n",
"}",
],
"description": "a func new mode"
},
10.創(chuàng)建一個結(jié)構(gòu)體模板
"Define a struct": {
"prefix": "..struct",
"body": "typedef struct \n{\n\t$2\n\t$3\n} ${1:name_t};"
},
11.創(chuàng)建一個枚舉模板
"Define a enum": {
"prefix": "..enum",
"body": "typedef enum \n\t{\n\t$2\n\t$3\n} ${1:name_t};"
},
12.創(chuàng)建一個作者聲明模板
"author.body": {
"prefix": "..author.body",
"body": "${author.body}",
},
13.創(chuàng)建一個函數(shù)注釋模板
"Print to func note": {
"prefix": "..func.note",
"body":
[
"/**************************************************************************************",
"** @name: ${TM_SELECTED_TEXT}",
"** @brief: $2",
"** @param: $3",
"** @retval: $4",
"** @author: $5${author.body}",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
"** @version: V0.0",
"---------------------------------------------------------------------------------------",
"** @modified: $6",
"** @date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
"** @version: V0.0",
"** @description: $7",
"** @note: $8",
"**************************************************************************************/",
],
"description": "a funcnote mode"
},
14.創(chuàng)建一個for循環(huán)模板
"For loop": {
"prefix": "..for",
"body": [
"for (${1:int i} = 0; ${1:i} < ${2:count}; ${1:i}${3:++})",
"{\n\t$4\n}"
]
},
15.創(chuàng)建一個do…while循環(huán)模板
"Do while loop": {
"prefix": "..do",
"body": "do {\n\t$0\n} while($1);"
},
16.創(chuàng)建一個while循環(huán)模板
"While loop": {
"prefix": "..while",
"body": "while ($1)\n{\n\t$2\n}"
},
17.創(chuàng)建一個switch分支選擇模板文章來源：http://www.zghlxwxcb.cn/news/detail-841877.html
"Switch case": {
"prefix": "..switch",
"body": [
"switch ($1) {",
"case $2:\n\t$3\n\tbreak;\n",
"default:\n\tbreak;\n}$0"
]
},
18.創(chuàng)建一個printf打印模板文章來源地址http://www.zghlxwxcb.cn/news/detail-841877.html
"printf()": {
"prefix": "..printf",
"body": "printf(\"${1:%s }\\n\", $2);$3"
},
到了這里，關(guān)于使用VSCode創(chuàng)建自定義注釋及代碼段的方法的文章就介紹完了。如果您還想了解更多內(nèi)容，請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
