在編寫代碼時,注釋非常重要,可以幫助團隊成員更好地理解代碼的功能和實現方式。但是,手動編寫注釋非常耗費時間,因此,我們需要一些高效的工具來完成這項工作。Vscode的塊注釋就是一個非常好用的工具,下面我們從多個方面進行詳細闡述。
一、vscode塊注釋快捷鍵
<!-- vscode 中塊注釋快捷鍵 -->
ctrl+shift+a(mac: shift+option+a)
塊注釋快捷鍵使得我們可以快速地添加註釋,尤其是當我們需要添加大量的注釋時,可以大大提高我們編寫注釋的效率。
二、vscode塊注釋顯示
在我們編寫注釋時,往往需要預覽這些注釋,看看它們是否被正確地添加在了代碼的相關位置。在vscode中,我們可以使用快捷鍵 “Ctrl+/” 或 “Command+/” 來快速注釋/取消注釋一行或多行代碼。這種方式雖然方便,但並不是最好的方式,因為當代碼行數過多時,我們可能無法清晰地預覽哪些行被注釋了哪些行沒有被注釋。因此,我們可以使用vscode塊注釋來解決這個問題。
<!-- vscode 塊注釋快捷鍵 -->
ctrl+shift+a(mac: shift+option+a)
按下快捷鍵後,會出現以下界面:
/*
選中的代碼
*/
這樣,我們就可以清晰地預覽哪些代碼被注釋了,注釋的結構也非常清晰,非常方便我們進行閱讀。
三、vscode不提示代碼塊
當我們編寫代碼時,有些時候我們不想看到一些代碼塊或者注釋塊。這種時候,我們可以將這些代碼塊或注釋塊隱藏起來。我們可以使用vscode的一些插件來實現這個功能,比如 —— “Editor Group Layout” 插件,不僅可以隱藏非常長的代碼,還可以隱藏特定的注釋。
<!-- vscode 插件搜索-->Editor Group Layout
四、vscode塊注釋 markdown
在使用大量注釋時,我們很難在標準的注釋中正確地表示所有含義,因此,我們需要使用更加豐富和靈活的注釋方式。比如使用markdown語法來編寫注釋。vscode塊注釋也完全支持markdown格式,我們只需要在塊注釋的開頭加上 “/* ” 或 “/*+ “等鍵入 /* 後按下 Tab 鍵即可快速生成markdown注釋。
/**
* ### Markdown注釋演示
*
* ##### 表格
* | 1 | 2 | 3 |
* | - | - | - |
* | 4 | 5 | 6 |
* | 7 | 8 | 9 |
*
* 四號標題
* > 引用輸入
*
* `字元串`
五、vscode注釋快捷鍵
塊注釋快捷鍵雖然非常好用,但有時我們也需要一些其他的注釋快捷鍵來快速地添加特定類型的注釋。vscode塊注釋也支持添加其他類型的注釋快捷鍵,我們只需要在 “keybindings.json” 文件中進行相應的配置即可。比如我們可以使用 “Ctrl+Alt+J” 快捷鍵來添加作者信息:
{
"key": "ctrl+alt+j",
"command": "editor.action.insertSnippet",
"when": "editorTextFocus",
"args": {
"snippet": "/*\n * Author: Your Name\n */"
}
}
六、vscode注釋對齊
在編寫注釋時,對齊非常重要,可以使我們的注釋更加清晰,易於閱讀。vscode塊注釋可以幫助我們快速地對齊注釋。我們只需要在塊注釋的第一行中按下 “Tab” 鍵就可以快速地對齊注釋了。
/*
這是一個注釋
*/
七、vscode注釋插件
在vscode市場上,有很多優秀的注釋插件,比如:autoDocstring、Document This、Better Comments 等等。這些插件可以讓我們更加方便和快速地編寫注釋。
八、vscode代碼塊選取
在編寫代碼時,有時我們需要將一些代碼塊進行選擇,並添加相應的注釋。vscode也為我們提供了非常好用的代碼塊選取功能。在代碼塊選取後,我們可以快速地添加註釋,如下所示
// 選中的代碼塊
console.log('1');
console.log('2');
使用vscode塊注釋後,會得到以下注釋:
/*
console.log('1');
console.log('2');
*/
九、總結
以上就是vscode塊注釋的一些相關功能,可以幫助我們更加高效地編寫注釋,提高我們的開發效率。如果你還沒有使用這些功能,不妨試一試!
原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/152207.html