作為一名全能編程開發工程師,我們或多或少都會接觸到Visual Studio Code(以下簡稱vscode)這一編輯器。在日常的開發中,我們經常需要對代碼進行結構化的組織和調整,且在層次較多的代碼中有很高的效率需求。而此時,vscode大綱便顯現了其強大的作用。本文將從vscode大綱的定義、使用、插件功能、設置選項等方面進行詳細探究。
一、vscode大綱定義
大綱視圖是一種結構化概覽,顯示文檔的標題、段落、列表或代碼塊等結構的層次結構。在vscode中,它可以顯示已打開文件的結構視圖,並對代碼的結構進行可視化。在大綱中,可以快速跳轉到文件的特定部分,並根據需要摺疊/展開各層級。這種結構化視圖對於處理大型代碼庫非常有用,可以減少尋找特定函數或方法的時間。
二、vscode大綱使用
在vscode中查看大綱視圖非常簡單。在打開的文件中,我們可以通過兩種方式訪問大綱視圖:
1、使用鼠標
<!-- 代碼示例 -->
右上角豎線菜單 > 大綱視圖。
2、使用快捷鍵
<!-- 代碼示例 -->
鼠標移動到文本編輯器窗口中間,在 Windows 和 Linux 上使用 Ctrl+Shift+P,在 macOS 上使用 Cmd+Shift+P 打開命令面板。輸入“大綱視圖”,然後選擇 “視圖:切換大綱視圖”命令。此時,vscode會打開一個新的視圖區域,並在側邊欄中展示當前打開的文件的大綱結構。
三、vscode大綱視圖插件
除了基本的大綱視圖之外,vscode還支持許多有用的大綱視圖插件。下面是三個比較受歡迎的插件:
1、Better Comments
<!-- 代碼示例 -->
// TODO: This is a todo comment
// * This is an important comment
// ? This is a question
// ! This is an important warning
2、Code Outline
<!-- 代碼示例 -->
Rust:
fn main() {
println!("Hello, world!");
}
Python:
def hello():
print("Hello,World!")
3、VSCode-icons
<!-- 代碼示例 -->
將vscode中的默認圖標替換為更有意義的圖標,這有助於用戶區分不同類型的文件。支持多種不同的語言和應用。
四、vscode大綱設置
在vscode中,提供了多種大綱視圖的設置選項。例如,打開vscode中的設置面板,然後在搜索框中輸入“outline”,便可以找到與大綱視圖相關的選項,包括:
1、editor.showFoldingControls:是否顯示摺疊代碼功能。
<!-- 代碼示例 -->
默認值:always
這個選項可以有以下三個值:always(顯示摺疊代碼控制);mouseover(鼠標懸停於代碼摺疊時顯示摺疊代碼控制);none(不顯示摺疊代碼控制)。
2、editor.showFoldingHighlights:是否在摺疊代碼時顯示高亮。
<!-- 代碼示例 -->
默認值:true
這個選項決定了代碼展開時是否會出現高亮提示。
3、editor.tabSize:定義選項卡的內容,用於計算縮進的空格數。
<!-- 代碼示例 -->
默認值:4
五、vscode大綱的其他問題
在使用vscode大綱的過程中,我們還可能遇到一些常見的問題。下面是兩個解決方案:
1、vscode大綱找不到符號
有時大綱面板會因為指向的符號在項目中丟失或無法找到而無法顯示。通常情況下,重新打開編輯器或文件都可以解決問題。如果這種方法不起作用,可以嘗試運行VSCode的命令“Developer: Reload Window”,或者在 Visual Studio Code 中右鍵單擊“大綱視圖”,然後選擇“刷新”。
2、vscode大綱正在加載
如果開啟了大綱視圖並且看到某個文檔的邊欄上有一個加載符號(圓圈),表示大綱正在加載。在許多時候,它只是由於文檔很大,大綱界面要處理的任務也就更多,這需要更多的時間來完成。但如果您認為這個過程一直沒有結束,您可以嘗試在設置面板中更改以下選項來提高對大綱視圖的響應速度:
<!-- 代碼示例 -->
"outline.mode": "all",
六、vscode大綱不顯示函數選取
默認情況下,vscode的大綱在 TS 文件中不會將類方法標記為函數。如果您希望大綱中顯示函數選項,可以通過創建一個名為“settings.json”的文件來配置該選項。下面是示例代碼:
<!-- 代碼示例 -->
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"markdown.previewFrontMatter": "show",
"typescript.updateImportsOnFileMove.enabled": "always",
"editor.formatOnPaste": true,
"outline.problems.enabled": false,
"outline.showFunctions": true,
"workbench.colorTheme": "One Monokai Theme",
"editor.tabSize": 2,
"workbench.startupEditor": "none",
"cSpell.userWords": [
"chakra",
"kubectl",
"plotly"
]
}
上述代碼中,“outline.showFunctions”選項設置為“true”即可在大綱中顯示類方法。
七、總結
通過對vscode大綱的詳細介紹,我們了解了大綱視圖的定義,使用方法,插件功能以及相關設置選項。同時,也了解了可能出現的問題以及解決方案。在實際開發過程中,大綱視圖是一個非常有用的工具,幫助我們處理大型或具有層次結構的代碼,提高效率,減少時間浪費,是我們在工作中不可或缺的一部分。
原創文章,作者:HZRT,如若轉載,請註明出處:https://www.506064.com/zh-hant/n/145934.html