作為一個有思想有個性的程序員寫的代碼一定是要有風格的,比如什么佛祖保佑永無Bug、神獸護體等形式的注釋,既有趣又個性。
給大家介紹一個非常有中國風的注釋插件koroFileHeader,我們先來了解一下這個插件
koroFileHeader插件簡介
這個插件目前有1300+Star,全五星好評,8萬次下載,所以是個非常不錯的插件。
插件的作用是生成文件頭部注釋和函數注釋。
一鍵添加佛祖保佑注釋
在VSCode的插件市場中,搜索koroFileHeader並進行安裝,安裝完成后可以新建一個test.js文件,
如果你是windows電腦,使用ctrl+shift+p鍵,Mac電腦使用shift+command+p鍵,然后輸入/codeDesign,就可以選擇注釋圖案了
插件里邊的圖案有佛祖、佛曰、美女、龍圖騰......等等,你可以下載下來自己測試一下。
正常頭部文件注釋
其實這個"騷注釋"只是插件的功能之一,更多的應用是自動根據我們的需求快速生成注釋,比如在test.js中點擊快捷鍵ctrl+alt+i(Windows),如果你是Mac電腦點擊ctrl+cmd+i.就會快速生成這樣的代碼注釋(我這里以JS代碼注釋為例,但這個插件可以支持所有主流語言,支持自定義語言).
/*
* @Author: your name
* @Date: 2020-06-07 17:35:49
* @LastEditTime: 2020-06-07 17:37:04
* @LastEditors: Please set LastEditors
* @Description: In User Settings Edit
* @FilePath: \vue-element-admin-master\src\wangrong.js
*/
這時候你會發現這里的Author是需要配置的,其實配置這個也非常的容易,我們簡單配置一下。在VSCode菜單欄點擊File-Preferences-Settings-Extensions里找到File header Configuration,在文件頭部模塊中(Fileheader)點擊Edit in settings.json,修改配置文件如下:
{
"fileheader.configObj": {
},
"fileheader.customMade": {
"Author": "wangrong",
"Date": "Do not edit", // 文件創建時間(不變)
"LastEditors": "技術胖", // 文件最后編輯者
"LastEditTime": "Do not edit", // 文件最后編輯時間
"FilePath": "Do not edit" ,// 增加此項配置即可
}
}
修改完成后,要保存,然后退出VSCode,再進來,進入test.js,輸入ctrl+alt+i這時候就變成了下面的樣子。
/*
* @Author: wangrong
* @Date: 2020-05-21 10:29:21
* @LastEditors: 技術胖
* @LastEditTime: 2020-05-21 11:28:16
* @FilePath: \MarkDown_blog\test.js
*/