vscode配置C/C++环境

YuSoLi

山东大学电子信息硕士在读

VS Code配置

作者：谭九鼎链接： https://www. zhihu.com/question/3031 5894/answer/154979413

有改动。个人按照步骤后，做到复制上三个json那一步，就可以运行了。

我将settings.json中的'code-runner.clearPreviousOutput"设置为false，执行程序时光标会聚焦到控制台上，

并把tasks.json中 -fexec-charset=GBK 换成了UTF-8，不出现乱码现象

运行时ctrl + alt + n，调试时打好断点按F5

文件名不能有中文，否则调试的时候报错（运行没事）

vscode中文乱码

0. 前言

本文许多内容都可从VS Code官方文档： C++ programming with Visual Studio Code 以及各个扩展的文档中获得，并且他们还会进行更新

1. 环境的准备

VSC的官网、下载、安装

MinGW + 配置系统环境变量

安装扩展(extension)

C/C++：又名 cpptools，提供Debug和Format功能
Code Runner：右键即可编译运行单文件，很方便；但无法Dubug

其他可选扩展：

Bracket Pair Colorizer 2：彩虹花括号
One Dark Pro：大概是VS Code安装量最高的主题

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

GBKtoUTF8：把GBK编码的文档转换成UTF8编码的。此扩展很久没有更新了，可能有严重的bug
C++ Intellisense：用的是gtags，本文第一个版本的选择。效果非常非常一般
Include Autocomplete：提供头文件名字的补全，现在cpptools和vscode-clangd都已经自带这个功能了，所以不用装
C/C++ Snippets：Snippets即重用代码块，效果自己百度；这个扩展安装量虽高，不过个人感觉用处实在不大，cpptools和clangd也自带一些；你也可以选择其他的Snippets扩展甚至自己定义

2. 配置几个.json文件

创建一个你打算存放代码的文件夹，称作工作区文件夹； 路径不能含有中文和引号 ，最好不要有空格，我用的是 C:\VS-Code-C 。C和C++需要分别建立不同的文件夹，除非用虚拟工作区。不要选上一段建出来的文件夹，源代码和编译器要分开放。

用vscode在工作区文件夹下新建文件夹，名称为 .vscode 。不在资源管理里新建的原因是Windows的Explorer不允许创建的文件夹第一个字符是点（1903后才支持）。然后创建 launch.json，tasks.json，settings.json（ 不是setting.json ）放到 .vscode文件夹下 。

这几个文件的内容见下。有些地方可选修改，自己对照着注释看吧。注意：如果是写C++，tasks.json的一个地方必须要修改。

launch.json代码

externalConsole 可根据自己喜好修改；cwd可以是程序运行时的相对路径，如有需要可以改为 ${fileDirname}。 lldb我没用过就不多说了。type和request不变色是正常现象。

// https://github.com/Microsoft/vscode-cpptools/blob/master/launch.md
    "version": "0.2.0",
    "configurations": [{
        "name": "(gdb) Launch", // 配置名称，将会在启动配置的下拉菜单中显示
        "type": "cppdbg", // 配置类型，cppdbg对应cpptools提供的调试功能；可以认为此处只能是cppdbg
        "request": "launch", // 请求配置类型，可以为launch（启动）或attach（附加）
        "program": "${fileDirname}/${fileBasenameNoExtension}.exe", // 将要进行调试的程序的路径
        "args": [], // 程序调试时传递给程序的命令行参数，一般设为空即可
        "stopAtEntry": false, // 设为true时程序将暂停在程序入口处，相当于在main上打断点
        "cwd": "${workspaceFolder}", // 调试程序时的工作目录，此为工作区文件夹；改成${fileDirname}可变为文件所在目录
        "environment": [], // 环境变量
        "externalConsole": true, // 为true时使用单独的cmd窗口，与其它IDE一致；18年10月后设为false可调用VSC内置终端
        "internalConsoleOptions": "neverOpen", // 如果不设为neverOpen，调试时会跳到“调试控制台”选项卡，你应该不需要对gdb手动输命令吧？
        "MIMode": "gdb", // 指定连接的调试器，可以为gdb或lldb。但我没试过lldb
        "miDebuggerPath": "gdb.exe", // 调试器路径，Windows下后缀不能省略，Linux下则不要
        "setupCommands": [
            { // 模板自带，好像可以更好地显示STL容器的内容，具体作用自行Google
                "description": "Enable pretty-printing for gdb",
                "text": "-enable-pretty-printing",
                "ignoreFailures": false
        "preLaunchTask": "Compile" // 调试会话开始前执行的任务，一般为编译程序。与tasks.json的label相对应
}

tasks.json代码

如果是 编写C++ ，编译器需改成g++；如果不想要额外警告，把-Wall那一条删去；-std根据自己需要修改；Linux下不需要加-fexec-charset。

reveal控制编译时是否跳转到终端面板。可根据自己喜好修改；即使设为never，也只是不自动跳转，手动点进去还是可以看到信息。

// https://code.visualstudio.com/docs/editor/tasks
    "version": "2.0.0",
    "tasks": [{
        "label": "Compile", // 任务名称，与launch.json的preLaunchTask相对应
        "command": "gcc",   // 要使用的编译器，C++用g++
        "args": [
            "${file}",
            "-o",    // 指定输出文件名，不加该参数则默认输出a.exe，Linux下默认a.out
            "${fileDirname}/${fileBasenameNoExtension}.exe",
            "-g",    // 生成和调试有关的信息
            "-Wall", // 开启额外警告
            "-static-libgcc",     // 静态链接libgcc，一般都会加上
            "-fexec-charset=GBK", // 生成的程序使用GBK编码，不加这一条会导致Win下输出中文乱码
            // "-std=c11", // C++最新标准为c++17，或根据自己的需要进行修改
        ], // 编译的命令，其实相当于VSC帮你在终端中输了这些东西
        "type": "process", // process是vsc把预定义变量和转义解析后直接全部传给command；shell相当于先打开shell再输入命令，所以args还会经过shell再解析一遍
        "group": {
            "kind": "build",
            "isDefault": true // 不为true时ctrl shift B就要手动选择了
        "presentation": {
            "echo": true,
            "reveal": "always", // 执行任务时是否跳转到终端面板，可以为always，silent，never。具体参见VSC的文档
            "focus": false,     // 设为true后可以使执行task时焦点聚集在终端，但对编译C/C++来说，设为true没有意义
            "panel": "shared"   // 不同的文件的编译信息共享一个终端面板
        // "problemMatcher":"$gcc" // 此选项可以捕捉编译时终端里的报错信息；但因为有Lint，再开这个可能有双重报错
}

settings.json代码

把这个文件里的东西放到“用户设置”里可以覆盖全局设置，否则只在当前工作区才有效。这两点各有自己的优势。

Code Runner的命令行和某些选项可以根据自己的需要在此处修改，如果终端用的是cmd（ Win7 默认）需要改用注释掉的，或者把 terminal.integrated.shell.windows 改为PowerShell；Win10默认就是PS就不用改。

{
    "files.defaultLanguage": "c", // ctrl+N新建文件后默认的语言
    "editor.formatOnType": true,  // 输入分号(C/C++的语句结束标识)后自动格式化当前这一行的代码
    "editor.suggest.snippetsPreventQuickSuggestions": false, // clangd的snippets有很多的跳转点，不用这个就必须手动触发Intellisense了
    "editor.acceptSuggestionOnEnter": "off", // 我个人的习惯，按回车时一定是真正的换行，只有tab才会接受Intellisense
    // "editor.snippetSuggestions": "top", // （可选）snippets显示在补全列表顶端，默认是inline
    "code-runner.runInTerminal": true, // 设置成false会在“输出”中输出，无法输入
    "code-runner.executorMap": {
        //YuSLi: 下面这一行用于编译多文件，把'$filename'改成*.c即可。同理，C++也可以用这种方式进行多文件编译
        //"c": "cd $dir && gcc *.c -o '$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc -std=c11 -fexec-charset=GBK && &'$dir$fileNameWithoutExt'",
        //YuSLi: 下面这一行是原先的，用于做一下备份。
        "c": "cd $dir && gcc '$fileName' -o '$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc -std=c11 -fexec-charset=GBK && &'$dir$fileNameWithoutExt'",
        "cpp": "cd $dir && g++ '$fileName' -o '$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc -std=c++17 -fexec-charset=GBK && &'$dir$fileNameWithoutExt'"
        // "c": "cd $dir && gcc $fileName -o $fileNameWithoutExt.exe -Wall -g -O2 -static-libgcc -std=c11 -fexec-charset=GBK && $dir$fileNameWithoutExt",
        // "cpp": "cd $dir && g++ $fileName -o $fileNameWithoutExt.exe -Wall -g -O2 -static-libgcc -std=c++17 -fexec-charset=GBK && $dir$fileNameWithoutExt"
    }, // 右键run code时运行的命令；未注释的仅适用于PowerShell（Win10默认），文件名中有空格也可以编译运行；注释掉的适用于cmd（win7默认），PS和bash也能用，但文件名中有空格时无法运行
    "code-runner.saveFileBeforeRun": true, // run code前保存
    "code-runner.preserveFocus": false,     // 若为false，run code后光标会聚焦到终端上。如果需要频繁输入数据可设为false
    "code-runner.clearPreviousOutput": false, // 每次run code前清空属于code runner的终端消息，默认false
    "code-runner.ignoreSelection": true,   // 默认为false，效果是鼠标选中一块代码后可以单独执行，但C是编译型语言，不适合这样用
    "C_Cpp.clang_format_sortIncludes": true,
    "files.associations": {
        "stdio.h": "c"
    }, // 格式化时调整include的顺序（按字母排序）
}

c_cpp_properties.json

如果你确定不需要使用别人的库，则现在的版本（0.18.0之后） 不需要创建这个文件 了，cpptools会自动使用默认的设置。所以本文也不再包含此文件的配置。

如果你自己编写了头文件又不在workspaceFolder下，或是使用别人的库，就需要手动创建这个文件放到 .vscode 下了。模板可以参考： Microsoft/vscode-cpptools 。

一些曾经的经验：

库的路径要加到includePath和browse里
如果需要递归包含，末尾加 /** 。
这个json不允许有注释，其实按照json标准本来就不能有
compilerPath好像必需是MinGW的完整路径，精确到gcc.exe，否则会提示找不到头文件；Linux下是/usr/bin/gcc；但我很久没有测试过了
Windows下的目录分隔符为反斜杠，原本应使用两个反斜杠来转义，但直接用斜杠这里也接受
除了配置这个文件，还需要进行别的操作。一部分可以参考下文的“多文件编译”

补充知识

json是一种数据交换格式，大部分是JavaScript的子集现在变成完全子集了。在这里就是用作配置文件。VSC和各个扩展会读取json中的条目，来决定某些功能和行为。

这么多条目哪里来的呢？这其实和API差不多。扩展开发者会把允许修改的选项“告诉”VSC，各个扩展的安装页面都有写。作为使用者，输入的时候VSC会提示你哪些是可用的，所以其实很容易写。

为什么要往json里写这么多的东西？因为VSC本身并没有对C语言特别优待，对其他许多语言也一样。而且最关键的编译命令和VSC是没有关系的，这就是上面提到过的编辑器和编译器的事。VSC不负责、无法、不能编译C语言。

以开头的是预定义的变量，具体参见：file在实际运行时会替换成当前打开的文件名。

3. 写代码，编译，调试

新建文件后就可以写代码了。代码文件在保存工作区内都可以，可以自己建立文件夹， 不必放到.vscode文件夹里 ，但 路径里(包括文件名)不要含有中文和引号 ，最好不要有空格。

按Alt+Shift+F（或者用右键菜单）可以格式化代码，出现Intellisense的时候 按tab可以补全代码 。打出snippets时会出现多个跳转点，按tab可以跳到下一个去。

停止输入一小段时间（一秒）后就会有Lint，扩展会给一些建议性的warning（比如声明了变量但不使用），自己清楚就行。如果觉得不爽，也有方法不让它提示，比如去掉-Wall就会少一些。如果还想去掉更多的警告，我提示一下：-Wno-...。找好参数后可以用 #pragma GCC diagnostic ignored 或者加到各种Flags里。总之自己研究。

接下来说说运行的事。首先，编译是从源代码生成可执行文件的过程。而调试其实是一种特殊的运行，是能控制程序运行，方便之后修改的一种手段。这是两个不同的阶段，可能出现编译通过但调试失败，也可能直接编译就失败，还有可能编译还没开始就失败了。如果你只说“运行失败”，别人是看不出是哪个阶段出了问题的。如果确定某个阶段通过了，那就不用管那个阶段了，就能专注于解决别的阶段的问题。

按Ctrl+Shift+B单纯编译，按F5为编译加调试；本来ctrl+F5为运行但不调试，但现在cpptools暂不支持，还是会调试。Follow: Support "Run without debugging" · Issue #1201 · microsoft/vscode-cpptools

在写程序初期，我强烈建议 不要把f5当作编译来使用 ，因为有的bug只会产生警告，不会阻止编译，但这些东西越早期解决越好。编译信息会在底下的“终端”面板里，如果代码有错误，点进去可以看编译器报的信息；不过因为有Lint了，平常的错误可以马上被发现和修改，写代码就轻松很多。

加断点在列号前面点一下就行，右键可以加条件断点。如果想从一开始就停下来，可以加在main函数那里，或者 launch.json 中有个设置。开始调试后，按f11可以一步一步进行，箭头所指的那行代码就是 下一步要运行的代码 ；f5是一直运行到下一个断点，右键某一行代码可以选择一直运行到指定的那一行。

左边有个调试栏，可以看到变量的值，自动栏没有的可以手动添加：在代码里选中要监视的表达式，点右键有选项可以直接添加到Watch里，复杂的才需要手打。把鼠标放到变量上可以看到变量的值，但是只能识别简单的表达式。栈帧对于观察递归很有用。栈溢出和段错误时还可以抓取“异常”，自动跳转到出错的行。

特别的，对于数组：C语言的数组经过函数传递以后会退化为指针，直接添加表达式就只能看到第一个元素。此时可以强制转换成指向固定大小的数组指针再解引：例如 int arr[10] 传进函数里后就变成了 int* arr ，在Watch里添加 *(int(*)[10])arr ，这样就能看到完整的数组了。但长度必须是写死的，自己小心越界。或者简单的程序用全局变量数组就能一直看到了。另一种只对gdb且是非void 有效的写法：` arr@10`。

快捷键： vscode: Visual Studio Code 常用快捷键 - 志文工作室。英文文档中当然有快捷键的说明，还有Cheet Sheet可以看，而且英文文档会更新。这个单独列出来仅给初学者。

如果遇到错误，先看底下的“某些可能出现的错误”以及看评论区 。

Code Runner

如果你不需要调试，可以直接右键选run code，或者点右上角的播放按钮。如果在终端里运行，可以输入数据，但是少了显示时间的功能；在“输出”中则上面两项相反。

在终端中按Ctrl + C可以终止程序运行，下一次运行前必须保证当前程序已经终止了（对于task也是一样的）。如果你想要复制，选中内容后直接按一下右键就可以了；粘贴则是在未选中时按右键；这个操作仅限于Win10，ctrl+c也可以复制但可能一不小心就把程序终止了。

用它还可以在非工作区内编译运行程序，不过默认用的是gcc，除非把executorMap放到全局设置里。按照我的配置，task和Code Runner还有一点不同：working directory。前者是你打开的文件夹，后者是文件所在的文件夹。当然它们也都可以自己修改。

其实Code Runner只是代替你手动输命令 ，功能并不强，算是适用场景不同吧。不要以为run code跑个Hello World很简单，Code Runner就很强、前面那么多配置都是垃圾了。

另外，楼下的答主韩骏就是此扩展作者，有事统统找他（滑稽）。

多文件编译

如果你想进行少量的多文件编译，C语言直接用 gcc 源文件1.c 源文件2.c 头文件1.h 这样就好，C++用g++。默认生成a.exe，加-o可指定输出文件名，其余选项百度gcc使用教程。如果需要多次编译可以写一个批处理。

如果你想进行大量的多文件编译，请学习如何写makefile或使用cmake。然后把tasks的命令改成调用make等。

如果你想使用别人的库，比如ffmpeg，可能需要在命令中指定 -I 、 -l （小写的L）、 -L 。具体参数阅读那个库的文档。还可能需要把路径添加到c_cpp_properties.json里来配置Intellisense。

这些情况下可以考虑单独建一个工作区，不要和单文件编译的共用。其实不新建工程(Project)、只是单文件就能调试，是不利于以后使用和理解大型IDE的。不过初学也不用掌握那么多，不要觉得建工程很麻烦、不建工程就能编译很强就是了。

总之这些和VSC无关，用其它IDE或是手动编译也会遇到差不多的问题，也有点复杂。本文就不多讨论这些了，自行解决。

保存文件夹

以后 写代码必须打开之前那个建立好的文件夹 才能写，否则所有的Intellisense都没有，只有Code Runner能用。（主要是需要那四个json，新建其它文件夹需把那几个json复制过去就也能用）

可以创建一个快捷方式（右键新建），把工作区路径作为参数传给VSC主程序，记得打双引号；还可以加个图标。1.18有了真正的虚拟工作区，可以一个窗口包含多个不在一起的文件夹，“文件”菜单里也有“保存工作区”这个功能，但是我都没试过，不保证没问题。

清理临时文件

按照这样配置，长期编译代码下来肯定有一大堆的exe，还可能分散在不同的文件夹里。

可以考虑修改一下json文件，把生成文件的目录指定到一个专门放exe的文件夹里；如果不会，百度gcc使用教程以及看我的json里的注释。或者资源管理器右上角搜索*.exe然后手动删除。

也可也写个bat，放到工作区里，要用的时候右键Run Code：

del *.exe /q /s
del tempCodeRunnerFile.c /q /s
del a.out /q /s
del *.o /q /s

添加纯英文输入法

Windows 10，默认输入法只有一个微软拼音，按一次shift就能进行中英转换；为了保持兼容，按ctrl加空格也能进行中英转换，但这个快捷键正是强制触发Intellisense的快捷键。

所以，我强烈建议手动添加“英语”语言输入法，正常代码时切换到纯英文输入法（win+空格），在需要频繁中文注释或者在字符串里写中文时才用中文输入法的英文模式。

这样也可以解决某些游戏需要用到shift键但同样快捷键冲突的问题。具体操作可以自己百度，也可以看我写的这篇有点复杂的文章： Windows 切换显示语言与添加纯英文输入法。

某些可能出现的错误

为了阅读的连贯性，这一部分移到了“A. 一些其它可能出现的错误”。遇到问题优先查看那里是否已经提了。

4. 其他设置

我的一些其他的设置，用在全局settings.json里，根据自己的情况调整，不需要全部照着我的写。 写完一个以后要打逗号 ；最外面的那个大括号我没加，就别弄丢了。

现在的VSC用的是可视化的设置界面，其实原本是手动编辑且出现两列设置的。点击右上角那个花括号就能手动编辑。

"editor.fontFamily": "等距更纱黑体 SC", // 控制编辑器字体
"editor.fontSize": 16, // 同上
"editor.fontLigatures": true, // 连体字，效果不太好形容，见 https://typeof.net/Iosevka 最后一部分
"editor.minimap.enabled": false, // 我个人不用minimap，就是右边那个东西
"editor.dragAndDrop": false, // 选中文字后，可以拖动它们调整位置。我是不需要
"editor.cursorSmoothCaretAnimation": true, // 移动光标时变得平滑
"editor.smoothScrolling": true, // 滚动平滑，不过效果很微弱
"files.trimTrailingWhitespace": true, // 保存时，删除每一行末尾的空格
"files.insertFinalNewline": true, // 保存后文件最末尾加一整行空行，Linux下的习惯
"files.autoGuessEncoding": false, // 启用后，会在打开文件时尝试猜测字符集编码。我关闭的理由见6，默认也是禁用的
"workbench.colorTheme": "One Dark Pro", // 主题
"workbench.colorCustomizations": {
      "activityBar.foreground": "#39C5BB" // 自定义颜色；想定义其它位置参见官方文档
"workbench.settings.useSplitJSON": true, // 恢复手动编辑时的两列设置
"window.zoomLevel": 0.2, // 整体放大