1. 程式人生 > >Visual Studio Code 配置C/C++環境

Visual Studio Code 配置C/C++環境

行程 file 格式化 wal 正常 系統環境 input 註釋 編碼

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本身已經很久沒有更新了,故不推薦。下載以下兩個程序(都要):

  • LLVM Download Page 在此頁面下載Clang。選Pre-Built Binaries中的Clang for Windows (64-bit),不需要下.sig文件
  • MinGW-w64 - for 32 and 64 bit Windows 在此頁面下載MinGW-w64,點那個Download就行

下載好了以後安裝。添加環境變量時:選Add LLVM to the system PATH for all users

(即第二項,不過第三項也差不多)。Clang的安裝路徑(Destination folder)我推薦填C:\Program Files\LLVM,不裝那裏也行,下面的配置裏路徑就自己改。安裝完了以後可能會彈出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 Files\LLVM\bin)沒有在環境變量中,要加到path裏才行。

配置環境變量

下面我們來配置系統環境
在我的電腦上右鍵點擊屬性,然後依次點擊下面圖片的操作,將MinGW中的bin文件夾路徑添加進去(我的路徑為 D:\Program Files\MinGW\bin)
之後一直點擊確定即可
[註]:設置完系統環境變量之後需要重啟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不變色是正常現象。

 1 // https://github.com/Microsoft/vscode-cpptools/blob/master/launch.md
 2 {
 3     "version": "0.2.0",
 4     "configurations": [
 5         {
 6             "name": "(gdb) Launch", // 配置名稱,將會在啟動配置的下拉菜單中顯示
 7             "type": "cppdbg", // 配置類型,這裏只能為cppdbg
 8             "request": "launch", // 請求配置類型,可以為launch(啟動)或attach(附加)
 9             "program": "${fileDirname}/${fileBasenameNoExtension}.exe", // 將要進行調試的程序的路徑
10             "args": [], // 程序調試時傳遞給程序的命令行參數,一般設為空即可
11             "stopAtEntry": true, // 設為true時程序將暫停在程序入口處,我一般設置為true
12             "cwd": "${workspaceFolder}", // 調試程序時的工作目錄
13             "environment": [], // (環境變量?)
14             "externalConsole": true, // 調試時是否顯示控制臺窗口,一般設置為true顯示控制臺
15             "internalConsoleOptions": "neverOpen", // 如果不設為neverOpen,調試時會跳到“調試控制臺”選項卡,你應該不需要對gdb手動輸命令吧?
16             "MIMode": "gdb", // 指定連接的調試器,可以為gdb或lldb。但目前lldb在windows下沒有預編譯好的版本。
17             "miDebuggerPath": "gdb.exe", // 調試器路徑。
18             "setupCommands": [
19                 {
20                     "description": "Enable pretty-printing for gdb",
21                     "text": "-enable-pretty-printing",
22                     "ignoreFailures": false
23                 }
24             ],
25             "preLaunchTask": "Compile" // 調試會話開始前執行的任務,一般為編譯程序。與tasks.json的label相對應
26         }
27     ]
28 }

tasks.json代碼:

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

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

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

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

 1 // https://code.visualstudio.com/docs/editor/tasks
 2 {
 3     "version": "2.0.0",
 4     "tasks": [
 5         {
 6             "label": "Compile", // 任務名稱,與launch.json的preLaunchTask相對應
 7             "command": "clang++", // 要使用的編譯器
 8             "args": [
 9                 "${file}",
10                 "-o", // 指定輸出文件名,不加該參數則默認輸出a.exe
11                 "${fileDirname}/${fileBasenameNoExtension}.exe",
12                 "-g", // 生成和調試有關的信息
13                 "-Wall", // 開啟額外警告
14                 "-static-libgcc", // 靜態鏈接
15                 "-fcolor-diagnostics",
16                 "--target=x86_64-w64-mingw", // 默認target為msvc,不加這一條就會找不到頭文件
17                 "-std=c++17" // C語言最新標準為c11,或根據自己的需要進行修改
18             ], // 編譯命令參數
19             "type": "shell",
20             "group": {
21                 "kind": "build",
22                 "isDefault": true // 設為false可做到一個tasks.json配置多個編譯指令,需要自己修改本文件,我這裏不多提
23             },
24             "presentation": {
25                 "echo": true,
26                 "reveal": "always", // 在“終端”中顯示編譯信息的策略,可以為always,silent,never。具體參見VSC的文檔
27                 "focus": false, // 設為true後可以使執行task時焦點聚集在終端,但對編譯c和c++來說,設為true沒有意義
28                 "panel": "shared" // 不同的文件的編譯信息共享一個終端面板
29             }
30             // "problemMatcher":"$gcc" // 如果你不使用clang,去掉前面的註釋符,並在上一條之後加個逗號。照著我的教程做的不需要改(也可以把這行刪去)
31         }
32     ]
33 }

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

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

Visual Studio Code 配置C/C++環境