摘要:使用文件頭部注釋在當(dāng)前編輯文件中使用快捷鍵即可生成文件頭部注釋。函數(shù)注釋將光標(biāo)放在函數(shù)行或者將光標(biāo)放在函數(shù)上方的空白行使用快捷鍵,即可生成函數(shù)注釋。事實(shí)上,函數(shù)注釋在文件的任意位置都可生成,這里需要自己控制。
koroFileHeader
一個(gè)讀取用戶自定義模板,通過(guò)快捷鍵添加文件頭部注釋、在光標(biāo)處添加函數(shù)注釋的VsCode插件language
簡(jiǎn)體中文 | English
更新日志更新日志
常見(jiàn)問(wèn)題
簡(jiǎn)介
文件頭部添加注釋:
在文件開(kāi)頭添加注釋,記錄文件信息
支持用戶高度自定義注釋選項(xiàng)
保存文件的時(shí)候,自動(dòng)更新最后的編輯時(shí)間和編輯人
快捷鍵:window:ctrl+alt+i,mac:ctrl+cmd+i
在光標(biāo)處添加函數(shù)注釋:
在光標(biāo)處自動(dòng)生成一個(gè)注釋模板,下方有栗子
支持用戶高度自定義注釋選項(xiàng)
快捷鍵:window:ctrl+alt+t,mac:ctrl+cmd+t
快捷鍵不可用很可能是被占用了,參考這里
支持不同語(yǔ)言的注釋格式,如下。
支持注釋格式:頭部注釋和函數(shù)注釋目前支持以下兩種形式的注釋:
/**/形式,默認(rèn)情況下將生成此類注釋:
/* * @Description: * @Author: OBKoro1 * @Date: 2018-08-20 00:26:26 * @LastEditors: OBKoro1 * @LastEditTime: 2018-11-01 10:34:14 */
"""形式,讀取.py后綴,自動(dòng)生成python形式注釋,無(wú)需配置:
""" @Description: @Author: OBKoro1 @Date: 2018-10-24 21:57:52 @LastEditors: OBKoro1 @LastEditTime: 2018-11-01 10:35:54 """安裝
在 Vscode 擴(kuò)展商店中搜索koroFileHeader,點(diǎn)擊安裝即可。
使用文件頭部注釋:
在當(dāng)前編輯文件中使用快捷鍵:window:ctrl+alt+t/mac:ctrl+cmd+t,即可生成文件頭部注釋。
函數(shù)注釋:
將光標(biāo)放在函數(shù)行或者將光標(biāo)放在函數(shù)上方的空白行
使用快捷鍵window:ctrl+alt+t,mac:ctrl+cmd+t,即可生成函數(shù)注釋。
事實(shí)上,函數(shù)注釋在文件的任意位置都可生成,這里需要自己控制。
注釋模板的設(shè)置
默認(rèn)配置:
在用戶首選項(xiàng)中搜索fileheader,默認(rèn)配置為:
"fileheader.customMade": {} // 頭部注釋 "fileheader.cursorMode": {} // 函數(shù)注釋
用戶未設(shè)置的情況下,頭部注釋和函數(shù)注釋模板為:
自定義模板:
在用戶設(shè)置中,搜索fileheader
復(fù)制默認(rèn)配置+修改配置,重啟生效
如上設(shè)置,生成注釋:
// 文件頭部注釋 /* * @Description: * @version: * @Company: BAT * @Author: OBKoro1 * @Date: 2018-10-15 20:59:57 * @LastEditors: OBKoro1 * @LastEditTime: 2018-10-15 20:59:57
*/ // 函數(shù)注釋 /** * @name: * @test: test font * @msg: * @param {type} * @return: */自動(dòng)更新最后編輯時(shí)間、編輯人:
要開(kāi)啟這個(gè)功能,需要在首選項(xiàng)設(shè)置中填寫(xiě)對(duì)應(yīng)的屬性:
"fileheader.customMade": { "Date": "Do not edit", // 文件創(chuàng)建時(shí)間(不變) "LastEditors": "OBKoro1", // 文件最后編輯者 "LastEditTime": "Do not edit" // 文件最后編輯時(shí)間 } // 不填寫(xiě)對(duì)應(yīng)屬性即關(guān)閉對(duì)應(yīng)功能自動(dòng)更新編輯時(shí)間
示例:
最后如果覺(jué)得還不錯(cuò)的話,就給個(gè) Star ?? 鼓勵(lì)一下我吧~
博客、前端積累文檔、公眾號(hào)、GitHub
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://www.ezyhdfw.cn/yun/98439.html
摘要:使用文件頭部注釋在當(dāng)前編輯文件中使用快捷鍵即可生成文件頭部注釋。事實(shí)上,函數(shù)注釋在文件的任意位置都可生成,這里需要自己控制。 koroFileHeader 一個(gè)讀取用戶自定義模板,通過(guò)快捷鍵添加文件頭部注釋、在光標(biāo)處添加函數(shù)注釋的VsCode插件 language 簡(jiǎn)體中文 | English 一些文檔 支持語(yǔ)言 插件設(shè)置/配置 更新日志 常見(jiàn)問(wèn)題 簡(jiǎn)介 文件頭部添加注釋: 在文...
摘要:前端配置簡(jiǎn)體中文插件,一般會(huì)自動(dòng)識(shí)別你的環(huán)境,自動(dòng)提示是否需要簡(jiǎn)體中文的語(yǔ)言包。使用插件將目前配置保存到上,以后只需要從上獲取,就可以一次性安裝插件配置信息。 VS code-前端配置 showImg(https://segmentfault.com/img/bVbuK6l?w=1224&h=999); Chinese (Simplified) Language Pack for Vi...
摘要:插件集待補(bǔ)充。。。同時(shí),它還包含了用于轉(zhuǎn)換為格式和生成數(shù)據(jù)模式的選項(xiàng)用于壓縮合并和文件的應(yīng)用程序。它提供了大量自定義的設(shè)置,以及自動(dòng)壓縮保存并導(dǎo)出為文件的選項(xiàng)。修改文本的更多命名格式,包括駝峰命名下劃線分隔命名,命名以及命名等切換漂亮的主題 插件集 待補(bǔ)充。。。 20180903 文件 【Path Intellisense】 自動(dòng)補(bǔ)全路徑 瀏覽器 【Open-In-Browser】在...
摘要:插件集待補(bǔ)充。。。同時(shí),它還包含了用于轉(zhuǎn)換為格式和生成數(shù)據(jù)模式的選項(xiàng)用于壓縮合并和文件的應(yīng)用程序。它提供了大量自定義的設(shè)置,以及自動(dòng)壓縮保存并導(dǎo)出為文件的選項(xiàng)。修改文本的更多命名格式,包括駝峰命名下劃線分隔命名,命名以及命名等切換漂亮的主題 插件集 待補(bǔ)充。。。 20180903 文件 【Path Intellisense】 自動(dòng)補(bǔ)全路徑 瀏覽器 【Open-In-Browser】在...
閱讀 2712·2023-04-25 19:31
閱讀 2402·2021-11-04 16:11
閱讀 2999·2021-10-08 10:05
閱讀 1673·2021-09-30 09:48
閱讀 2516·2019-08-30 15:56
閱讀 2557·2019-08-30 15:56
閱讀 2311·2019-08-30 15:53
閱讀 2418·2019-08-30 15:44