首頁 > 軟體

Visual Studio Code 設定C/C++環境

2020-06-16 16:39:23

0. 前言

VS Code 是微軟發布一款跨平台的原始碼編輯器,其擁有強大的功能和豐富的擴充套件,使之能適合編寫許多語言。

本文面向初學者(但不是純小白),分享一點我設定C/C++的經驗。

本文所有內容均可從VS Code的官方文件:C++ programming with Visual Studio Code 以及各個擴充套件的文件中獲得,並且他們還會進行更新。

我的環境:64位元Windows 10。VS Code的組態檔在Linux下應該也是通用的,但需要修改路徑等部位設定。

1. 環境的準備

VS Code的官網和下載、安裝最新的版本。VS Code只是一個編輯器,並不是IDE(整合式開發環境)。不含編譯器(和許多其它功能),所以編譯器要自己安裝好。如果想用其他工具鏈或單純用官方擴充套件。

然後下載安裝MinGW-w64,其實MinGW和MinGW-w64只是名字像,它們是兩個不同的專案。為了方便,本文中的MinGW指的其實都是MinGW-w64。MinGW本身已經很久沒有更新了,故不推薦。下載以下兩個程式(都要):

下載好了以後安裝。新增環境變數時:選Add LLVM to the system PATH for all users(即第二項,不過第三項也差不多)。Clang的安裝路徑(Destination folder)我推薦填C:Program FilesLLVM,不裝那裡也行,下面的設定裡路徑就自己改。安裝完了以後可能會彈出cmd說MSVC integration install failed。這個是因為Clang預設使用的是msvc的工具鏈,而我們選擇的工具鏈是MinGW,所以就不用管這個提示

MinGW隨便裝哪,Architecture選x86_64,裝好以後把東西全部複製到Clang的資料夾裡去,他們會無衝突合併。同樣,不做這一步也行,下面的設定裡路徑就自己改,還要手動把MinGW的bin資料夾加到path中,因為MinGW不會自己加。至於為什麼既要裝Clang又要裝MinGW,是因為Clang沒有標頭檔案。然後就可以把MinGW刪了(Uninstall.exe)。不建議安裝多個MinGW,如果你安裝了其他IDE需要注意把其他的MinGW從環境變數中去掉;也可以自己把他們的編譯器設為Clang。因為幾乎所有的輕量級IDE用的都是MinGW或TDM-GCC,它們不製造編譯器,只是打包了一個。而且它們用在VSC裡也會有奇怪的錯誤。

執行cmd,輸clang,應該會提示no input files而不是“不是內部命令或外部命令”或者“無法將“clang”項識別為 cmdlet、函數、指令碼檔案或可執行程式的名稱”。輸clang -v或gcc -v可以顯示出各自的版本。如果是“不是內部命令或外部命令”,說明clang.exe在的資料夾(我的是C:Program FilesLLVMbin)沒有在環境變數中,要加到path裡才行。

設定環境變數 

下面我們來設定系統環境
在我的電腦上右鍵點選屬性,然後依次點選下面圖片的操作,將MinGW中的bin資料夾路徑新增進去(我的路徑為 D:Program FilesMinGWbin)
之後一直點選確定即可
[註]:設定完系統環境變數之後需要重新啟動vs code

 

 

 

 

需要安裝的擴充套件:

  • C/C++(就是有些教學裡的cpptools)
  • C/C++ Clang Command Adapter:提供靜態檢測(Lint),很重要
  • Code Runner:右鍵即可編譯執行單檔案,很方便

其他可選擴充套件:

  • Bracket Pair Colorizer:彩虹花括號
  • Include Autocomplete:提供標頭檔案名字的補全
  • C/C++ Snippets:Snippets即重用程式碼塊,效果自己百度;這個擴充套件安裝量雖高,不過個人感覺用處實在不大,你也可以選擇其他的Snippets擴充套件甚至自己定義
  • One Dark Pro:大概是VS Code安裝量最高的主題
  • vscode-clangd:這個和Adapter二選一,出得比Adapter晚,下載量也低,但卻是llvm官方出的。出現問題時可以換著試試

不建議/不需要裝的擴充套件:

  • GBKtoUTF8:把GBK編碼的文件轉換成UTF8編碼的。此擴充套件可能有嚴重的bug,參見第6點,總之不建議裝
  • C++ Intellisense:用的是gtags,本文第一個版本的選擇。效果非常非常一般。
  • C/C++ Advanced Lint:即cppflylint,本文第二個版本的選擇。會產生許多奇怪的警告。總之“過時”了
  • Clang-Format:Adapter包含了此功能

2. 設定四個.json檔案

先建立一個你打算存放程式碼的資料夾(稱作工作區),路徑不能含有中文和空格和引號C語言和c++需要建立不同的工作區(除非你懂得下面json檔案的某些選項,則可以做到一個工作區使用不同的build task)。

開啟VS Code,選開啟資料夾(不要選“新增工作區資料夾”,理由見上一句),選擇剛才那個資料夾,點VS Code上的新建資料夾,名稱為.vscode(這樣做的原因是Windows的Explorer不允許建立的資料夾第一個字元是點),然後建立 launch.json,tasks.json,settings.json,c_cpp_properties.json放到.vscode資料夾下,效果圖:

launch.json程式碼:

stopAtEntry可根據自己喜好修改;cwd可以控制程式執行時的相對路徑,如有需要可以改為${fileDirname}。其他無需更改,除非你不用windows,則可以用lldb偵錯(需要自己裝)。type和request不變色是正常現象。

// https://github.com/Microsoft/vscode-cpptools/blob/master/launch.md
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(gdb) Launch", // 設定名稱,將會在啟動設定的下拉式選單中顯示
            "type": "cppdbg", // 設定型別,這裡只能為cppdbg
            "request": "launch", // 請求設定型別,可以為launch(啟動)或attach(附加)
            "program": "${fileDirname}/${fileBasenameNoExtension}.exe", // 將要進行偵錯的程式的路徑
            "args": [], // 程式偵錯時傳遞給程式的命令列引數,一般設為空即可
            "stopAtEntry": true, // 設為true時程式將暫停在程式入口處,我一般設定為true
            "cwd": "${workspaceFolder}", // 偵錯程式時的工作目錄
            "environment": [], // (環境變數?)
            "externalConsole": true, // 偵錯時是否顯示控制台視窗,一般設定為true顯示控制台
            "internalConsoleOptions": "neverOpen", // 如果不設為neverOpen,偵錯時會跳到“偵錯控制台”索引標籤,你應該不需要對gdb手動輸命令吧?
            "MIMode": "gdb", // 指定連線的偵錯程式,可以為gdb或lldb。但目前lldb在windows下沒有預編譯好的版本。
            "miDebuggerPath": "gdb.exe", // 偵錯程式路徑。
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": false
                }
            ],
            "preLaunchTask": "Compile" // 偵錯對談開始前執行的任務,一般為編譯程式。與tasks.json的label相對應
        }
    ]
}

tasks.json程式碼:

reveal可根據自己喜好修改,即使設為never,也只是編譯時不跳轉到“終端”而已,手動點進去還是可以看到,我個人設為never。

命令列引數方面,-std根據自己的需要修改。如果使用Clang編寫C語言,把command的值改成clang。

如果使用MinGW,編譯C用gcc,編譯c++用g++,並把-target和-fcolor那兩條刪去。如果不想要額外警告,把-Wall那一條刪去。

引數的作用我加了註釋,還看不懂,百度gcc使用教學。

// https://code.visualstudio.com/docs/editor/tasks
{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Compile", // 任務名稱,與launch.json的preLaunchTask相對應
            "command": "clang++", // 要使用的編譯器
            "args": [
                "${file}",
                "-o", // 指定輸出檔名,不加該引數則預設輸出a.exe
                "${fileDirname}/${fileBasenameNoExtension}.exe",
                "-g", // 生成和偵錯有關的資訊
                "-Wall", // 開啟額外警告
                "-static-libgcc", // 靜態連結
                "-fcolor-diagnostics",
                "--target=x86_64-w64-mingw", // 預設target為msvc,不加這一條就會找不到標頭檔案
                "-std=c++17" // C語言最新標準為c11,或根據自己的需要進行修改
            ], // 編譯命令引數
            "type": "shell",
            "group": {
                "kind": "build",
                "isDefault": true // 設為false可做到一個tasks.json設定多個編譯指令,需要自己修改本檔案,我這裡不多提
            },
            "presentation": {
                "echo": true,
                "reveal": "always", // 在“終端”中顯示編譯資訊的策略,可以為always,silent,never。具體參見VSC的文件
                "focus": false, // 設為true後可以使執行task時焦點聚集在終端,但對編譯c和c++來說,設為true沒有意義
                "panel": "shared" // 不同的檔案的編譯資訊共用一個終端面板
            }
            // "problemMatcher":"$gcc" // 如果你不使用clang,去掉前面的註釋符,並在上一條之後加個逗號。照著我的教學做的不需要改(也可以把這行刪去)
        }
    ]
}

settings.json程式碼:

把這個檔案裡的東西放到“使用者設定”裡也可以覆蓋全域性設定,自己進行選擇。

Code Runner的命令列和某些選項可以根據自己的需要在此處修改,用法還是參見此擴充套件的文件和百度gcc使用教學。

如果你要使用其他地方的標頭檔案和庫檔案,可能要往clang.cflags和clang.cxxflags裡加-I和-L,用法百度gcc使用教學。

clang的補全,在我過去的測試過程中會讓VSC非常卡,但是現在好像沒有這個問題了。

如果你卡,就把clang的補全關掉,用cpptools的。

Linux下去掉code runner和flags的--target那一條,共四個。

{
    "files.defaultLanguage": "cpp", // ctrl+N新建檔案後預設的語言
    "editor.formatOnType": true, // 輸入時就進行格式化,預設觸發字元較少,分號可以觸發
    "editor.snippetSuggestions": "top", // snippets程式碼優先顯示補全

    "code-runner.runInTerminal": true, // 設定成false會在“輸出”中輸出,無法輸入
    "code-runner.executorMap": {
        "c": "cd $dir && clang $fileName -o $fileNameWithoutExt.exe -Wall -g -Og -static-libgcc -fcolor-diagnostics --target=x86_64-w64-mingw -std=c11 && $dir$fileNameWithoutExt",
        "cpp": "cd $dir && clang++ $fileName -o $fileNameWithoutExt.exe -Wall -g -Og -static-libgcc -fcolor-diagnostics --target=x86_64-w64-mingw -std=c++17 && $dir$fileNameWithoutExt"
    }, // 設定code runner的命令列
    "code-runner.saveFileBeforeRun": true, // run code前儲存
    "code-runner.preserveFocus": true, // 若為false,run code後游標會聚焦到終端上。如果需要頻繁輸入資料可設為false
    "code-runner.clearPreviousOutput": false, // 每次run code前清空屬於code runner的終端訊息

    "C_Cpp.clang_format_sortIncludes": true, // 格式化時調整include的順序(按字母排序)
    "C_Cpp.intelliSenseEngine": "Default", // 可以為Default或Tag Parser,後者較老,功能較簡單。具體差別參考cpptools擴充套件文件
    "C_Cpp.errorSquiggles": "Disabled", // 因為有clang的lint,所以關掉
    "C_Cpp.autocomplete": "Disabled", // 因為有clang的補全,所以關掉

    "clang.cflags": [ // 控制c語言靜態檢測的引數
        "--target=x86_64-w64-mingw",
        "-std=c11",
        "-Wall"
    ],
    "clang.cxxflags": [ // 控制c++靜態檢測時的引數
        "--target=x86_64-w64-mingw",
        "-std=c++17",
        "-Wall"
    ],
    "clang.completion.enable":true // 效果效果比cpptools要好
}

c_cpp_properties.json程式碼:

此檔案內容來自於Microsoft/vscode-cpptools;這個json不允許有注釋(其實按照標準本來就不能有)。

如果你沒有合併Clang和MinGW,則該檔案中的compilerPath必需修改成MinGW的完整路徑,精確到gcc.exe,否則會提示找不到標頭檔案;Linux下應該是/usr/bin/gcc。

如果你自己編寫了標頭檔案又不在workspaceFolder下,路徑也要加到includePath和browse裡。這些路徑是否遞回有效暫時未知,我的測試是有效的。

Windows下的路徑為反斜槓,原本應使用兩個反斜槓來跳脫,但直接用斜槓在VS Code中也接受。

{
    "configurations": [
        {
            "name": "MinGW",
            "intelliSenseMode": "clang-x64",
            "compilerPath": "C:/Program Files/LLVM/bin/gcc.exe",
            "includePath": [
                "${workspaceFolder}"
            ],
            "defines": [],
            "browse": {
                "path": [
                    "${workspaceFolder}"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            },
            "cStandard": "c11",
            "cppStandard": "c++17"
        }
    ],
    "version": 4
}

為什麼要往json裡寫這麼多的東西?因為VSC本身並沒有對C語言特別優待,對其他許多語言也是這樣。另外稍微提一下,以$開頭的是VSC預定義的變數,具體參見:Variables Reference

關於VS Code輸出會出現亂碼,很多人都遇到過。這是因為VS Code內部用的是utf-8編碼,cmd/powershell是gbk編碼。直接編譯,會把“你好”輸出成“浣犲ソ”。
其實可以點右下角 選Reopen with Encoding 選Chinese GBK 就可以正常輸入中文了,而且輸出也是正常的
還可以在設定裡搜尋encode,把files.encoding改成gbk,而且最好把files.autoGuessEncoding也改成true

本文主要在作者:譚九鼎 (連結)的基礎上簡化。

https://www.zhihu.com/question/30315894/answer/154979413

 


IT145.com E-mail:sddin#qq.com