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

 

 

0. 前言

 

本文主要在做者:譚九鼎 (連接)的文章上進行抄襲,對一些步驟進行簡化對初學者更友好。html

 若是你在配置過程仍有問題,歡迎 聯繫qq:577014284,交流學習。c++

 

VS Code 是微軟發佈一款跨平臺的源代碼編輯器,其擁有強大的功能和豐富的擴展,使之能適合編寫許多語言。git

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

本文全部內容都可從VS Code的官方文檔:C++ programming with Visual Studio Code 以及各個擴展的文檔中得到,而且他們還會進行更新。shell

個人環境:64位Windows 10。VS Code的配置文件在Linux下應該也是通用的,但須要修改路徑等部位配置。json

 

1. 環境的準備

VS Code的官網和下載、安裝最新的版本。VS Code只是一個編輯器,並非IDE(集成開發環境)。不含編譯器(和許多其它功能),因此編譯器要本身安裝好。若是想用其餘工具鏈或單純用官方擴展。windows

而後下載安裝MinGW-w64,其實MinGW和MinGW-w64只是名字像,它們是兩個不一樣的項目。爲了方便,本文中的MinGW指的其實都是MinGW-w64。MinGW自己已經好久沒有更新了,故不推薦。下載如下兩個程序(都要):編輯器

下載好了之後安裝。添加環境變量時:選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裏才行。

配置環境變量(使用clang+mingw跳過) 

下面咱們來配置系統環境
在個人電腦上右鍵點擊屬性,而後依次點擊下面圖片的操做,將MinGW中的bin文件夾路徑添加進去(個人路徑爲 D:\Program Files\MinGW\bin)
以後一直點擊肯定便可
[注]:設置完系統環境變量以後須要重啓vs code


 

 

 

若是不使用clang,直接增長MinGw的環境變量便可。 

(文章尾有隻配置 gcc 的對應 json 文件下載)

 


須要安裝的擴展:

  • 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文件夾下,效果圖:

 
特別注意:C/C++文件放在與.vscode 的所在的同級目錄中,.vscode 只放置4個json文件。
 

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 }

 

以上是 clang+mingw 的json代碼。

 

這是個人 clang+mingw 環境及測試,注意路徑設置。

https://www.lanzous.com/i8sqjde

這裏分享一個只配置 gcc 環境例子,注意路徑設置。

https://www.lanzous.com/i8lkz3c

 

爲何要往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

相關文章
相關標籤/搜索