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

前言

 

本文主要在作者:谭九鼎 (链接)的文章上进行抄袭,对一些步骤进行简化对初学者更友好。

如果你已经拥有一些命令行、程序编译和调试,以及使用VS Code的知识,请移步到原文获得更加详细的介绍。

如果你在配置过程仍有问题,欢迎 联系qq:577014284,交流学习。

 

VS Code 是微软发布一款跨平台的源代码编辑器,其拥有强大的功能和丰富的扩展,使之能适合编写许多语言。

本文面向初学者(但不是纯小白),分享一点我配置 C/C++ 的经验。

本文所有内容均可从VS Code的官方文档:C++ programming with Visual Studio Code 以及各个扩展的文档中获得,并且他们还会进行更新。

我的环境:Windows 10 x64、macOS 10.15。VS Code的配置文件在Linux下应该也是通用的,但需要修改路径等部位配置。

 

环境的准备

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 往下翻,在版本选择中选最新版本中的 x86_64-posix-seh
  • 由于文件在外网,部分同学下载太慢,故提供 Win64 版本方便下载:链接: 密码: g5h5

 

本文提供两种解决方案

gcc 精简版

下载安装 gcc C/C++ 扩展,添加 gcc 环境变量,打开文件夹,新建 helloworld 源代码并保存,按 F1,输入 build and debug active file。完。

 

增加环境变量

增加 gcc 环境变量

在我的电脑上右键点击属性,然后依次点击下面图片的操作,

之后点击确定即可
[注]:设置完系统环境变量之后需要重启 vs code

可选配置

在 vscode 中新建 .vscode 文件夹,放入下面链接的四个 Json 文件。里面包含 插件 code runner 运行配置和 C/C++ 的调试配置。

https://suwen.lanzous.com/icioivi

注意:修改 c_cpp_properties.json 中的 compilerPath,

 "compilerPath": "${gcc的安装绝对路径}/mingw64/bin/gcc.exe",

Clang + gcc 配置版

推荐使用, 详见: Clang 比 GCC 好在哪里?

环境的准备

下载 Clang 以后安装。添加环境变量时:选 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解压在哪,解压好以后把 build-info.txt 所在目录 的所有东西全部复制到 Clang 的文件夹里去,他们会无冲突合并【如下图】。同样,不做这一步也行,下面的配置里路径就自己改,添加 gcc 环境变量。

至于为什么既要装Clang又要装MinGW,是因为 Clang 没有头文件。然后就可以把MinGW删了。不建议安装多个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里才行。

win10 如果已经增加环境变量仍出现 “不是内部命令或外部命令……”  请先尝试重启电脑。

 

将把 build-info.txt 所在目录 所有文件夹路径添加进去

 

 

需要安装的扩展:

  • C/C++(就是有些教程里的cpptools)
  • C/C++ Clang Command Adapter:提供静态检测(Lint),很重要
  • Code Runner:右键即可编译运行单文件,很方便

其他可选扩展:

  • Bracket Pair Colorizer:彩虹花括号
  • Include Autocomplete:提供头文件名字的补全
  • One Dark Pro:大概是VS Code安装量最高的主题

不建议/不需要装的扩展:

  • GBKtoUTF8:把GBK编码的文档转换成UTF8编码的。此扩展可能有严重的bug,参见第6点,总之不建议装
  • C++ Intellisense:用的是gtags,本文第一个版本的选择。效果非常非常一般。
  • C/C++ Advanced Lint:即cppflylint,本文第二个版本的选择。会产生许多奇怪的警告。总之“过时”了
  • Clang-Format:Adapter包含了此功能

 

配置四个.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,也只是不自动跳转,手动点进去还是可以看到信息。

命令行参数方面,-std 根据自己的需要修改。如果使用 Clang 编写C语言,把 command 的值改成 clang

如果使用 MinGW,编译 C 用 gcc,编译 c++用 g++,并把 -target 和 -fcolor 那两条删去。

如果不想要额外警告,把 -Wall 那一条删去。

Linux下不需要加-fexec-charset。

反正这些我都加了注释,还看不懂,百度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 runne r和 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

 

 

为什么要往 json 里写这么多的东西?因为 VSC 本身并没有对 C 语言特别优待,对其他许多语言也是这样。另外稍微提一下,以 $ 开头的是 VSC 预定义的变量,具体参见:Variables Reference

 

 

 

posted @ 2018-11-24 16:50  别依梦雨轩  阅读(81494)  评论(68编辑  收藏