本文主要讲如何在vscode上实现编译/运行/调试C以及C++,如果是初学者,就请完全按照文章的步骤
本文许多内容都可从VS Code官方文档:C++ programming with Visual Studio Code 以及各个扩展的文档中获得,并且他们还会进行更新(本文也进行过几次重大更新),如果你想更深入了解,可以去看。本文也基本上是由多次尝试得出来的,如果有错误可以指出。

最终效果:实时显示编译阶段的错误、代码片段、补全、格式化、单文件的编译与调试

1、环境的准备

1.首先在微软官网下载并安装好visual stdio code,建议在安装时将选项全勾选上
VScode安装

勾选后在文件和文件夹的右键菜单中会多出 Open with Code这个选项,也就是用vscode打开当前文件/文件夹

2.因为vscode只是一个代码编辑器,没有自带有C/C++的编译器,因此首先需要安装一个C/C++编译器并且设置环境变量。 MinGw 是 Minimal GNU on Windows 的缩写,允许在 GNU/Linux 和 Windows 平台生成本地的 Windows 程序而不需要第三方运行时库。这里使用mingw-w64。因为网络问题mingw-w64很难下载,建议离线下载然后手动添加环境变量
离线下载的地址:
https://sourceforge.net/projects/mingw-w64/files/mingw-w64/

3.将下载好的安装文件解压到目录,如 C:\MinGw,下面修改环境变量时还会用到。

4.修改环境变量: 选择计算机—属性---高级系统设置---环境变量,在系统变量中找到 Path 变量,在后面加入 min-gw的安装目录,如 C:\MinGw\bin
添加环境变量


2、VScode插件安装

安装必要的插件,打开vscode,点击左面竖排第五个按钮,搜索并安装上如下几个插件

VScode插件

安装好以后重启一下vscode,界面切换为中文,为了避免麻烦,暂时不要安装其他插件


3、代码运行

安装完成后,重启 VScode,会在右上角找到一个三角形标志,这个标志就是用来编译的。
点击运行按钮运行代码

接下来点击 文件 > 首选项 > 设置 > 用户设置 > 拓展 > Run Code Configuration,找到 Run In Terminal 选项并打上勾。这一步是为了解决程序中 scanf()等请求键盘输入数据的函数,在运行时无法从键盘输入数据的问题。
Run In Terminal

完成后,找一个代码文件,例如 123.c 文件,点击 VScode 右上角的三角形,即可自动进行编译运行。
运行代码
会发现界面成功输出英文,中文乱码。
乱码问题,可以在第四步配置settings.json文件时设置编码方式,设置后,将不会有中文乱码问题。


4、配置几个.json文件(为调试做准备)

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

打开VSC,选打开文件夹;最好不要选“添加工作区文件夹”,这个就是虚拟工作区,我没用过,不保证没问题。点新建文件夹,名称为.vscode。不在资源管理里新建的原因是Windows的Explorer不允许创建的文件夹第一个字符是点(1903后才支持)。然后创建 launch.json,tasks.json,settings.json(不是setting.json) 放到.vscode文件夹下。效果图:

工作区图片

这几个文件的内容见下。复制以下代码出来后,知乎会自动在前面加上几行保留所有权利的字,实际使用的时候肯定要删了的。有些地方可选修改,自己对照着注释看吧。注意:如果是写C++,tasks.json的一个地方必须要修改。

launch.json代码

externalConsole可根据自己喜好修改;
集成终端在底部终端栏输入数据,如果是希望像vs2019一样,启动调试后显示外部窗口而不是在vscode集成终端进行调试,只需将launch.json中的"externalConsole"后面的值由false改为true
cwd可以是程序运行时的相对路径,如有需要可以改为${fileDirname}

// 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++,编译器需把"command"中的"gcc"改成"g++";如果不想要额外警告,把-Wall那一条删去;-std根据自己需要修改;Linux下不需要加-fexec-charset。反正这些我都加了注释,还看不懂,百度gcc使用教程。

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的命令行和某些选项可以根据自己的需要在此处修改,想自定义或者想知道是什么意思还是参见此扩展的文档和百度gcc使用教程。如果终端用的是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": {
        "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": true,     // 若为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, // 格式化时调整include的顺序(按字母排序)
}

补充知识

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

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

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

5、断点调试

强调:调试是属于工作区设置,当前配置的调试环境只会对当前.vscode文件夹所在路径下的文件生效,如果要换用别的文件夹,可以直接把.vscode这个文件夹拷贝过去.

事实上现在已经可以正常调试了,并且现在可以按 ctrl+shift+b 直接调用配置好的task编译而不运行程序,类似于一些IDE的编译选项
测试一下,新建一个.c文件将下面的代码粘贴进去,并在适当的地方添加上断点。

#include <stdio.h>
int main()
{
   char name[100];
   printf("What is your name?\n你的名字是?\n");
   scanf("%s", name);
   printf("Hello,%s,nice to meet you!\n你好,%s,很高兴认识你!", name,name);
}

image

按f5或者启动调试的按钮启动调试,程序执行到断点处会停下
image

顶部六个按钮分别代表

  1. 继续执行到下一个断点处
  2. 执行下一条语句,遇到函数直接执行完不会跳转进函数
  3. 执行下一条语句,遇到函数会跳转进函数继续单步执行
  4. 跳出当前所在的函数,如果是主函数会结束程序
  5. 重新启动调试
  6. 结束调试

6、中文乱码问题

原因:VSCode 与 cmd 两者之间的编码方式不一样:VSCode 默认是 utf-8 编码,而在中国地区下的 Windows 的 cmd 默认是 GBK 编码。
而在VSCode中运行C/C++代码是调用Windows中的cmd终端执行的,所以不同编码格式下的中文会出现乱码。

十进制码值对应编码名称
950繁体中文
65001UTF-8代码页
936简体中文默认的GBK
437MS-DOS 美国英语

GBK是微软基于中国国标GB2312发展来的,是Windows中文版的缺省编码。一个文本没有特别的编码标识符情况下,会被中文Windows识别为GBK编码。而UTF-8在Windows系统下,微软是规定需要有UTF8BOM标示符才行的。因此,GBK编码的使用,主要是为了兼容Windows系统。

UTF8则是Linux的标准编码,而且Linux标准中UTF8是不允许带BOM标示符的,Linux只允许UTF16,UTF32这些编码带BOM。因此,没有任何标示符的情况下,会被Linux识别为UTF8编码,对UTF8的支持可以更好的兼容Linux平台。

起初国内网站大多数都是GBK编码,但是GBK问题不少,特别是网站有多语言需求的时候,能折腾死人,各种乱码。后来UTF-8普及了以后,大家发现UTF-8的优势就纷纷转向她的怀抱,可以做到一次开发,全球运行 233。

需要统一两者的编码格式,才能正常输出中文,第四步中的setting已经设置编译时用-fexec-charset=GBK这个参数(目前的配置是有的),生成的程序就是GBK编码的,源文件仍是UTF8。完美解决问题。

下文几个更改编码格式的方法已经过时,存在一定问题,不建议阅读


6.1、更改编码格式的方法(过期内容,谨慎阅读)

1、自动识别编码

可以设置VScode为自动识别并设置编码,打开设置,勾选Auto Guess Encoding

设置过程如图所示

设置Auto Guess Encoding

设置完成后,重新用VScode打开文件,就可以看到讲文件设置成GBK编码

识别为GBK编码
如果识别成了别的编码格式,可以点击编码格式手动选择

手动更改编码格式

2、更改VS Code的默认编码格式:

更改默认编码格式

3、更改VS Code中终端的编码格式

经过尝试,我发现VS Code中终端的编码格式设置和Windows中的编码格式设置好像不是同步的,也就是说如果设置了windows中cmd等终端的编码格式,VS Code里的终端的编码格式依然没有更改。

在VSCode中通过打开“文件”--“首选项”--“设置”, 然后在setting.json中设置, 把下面三行复制到里面:

    "terminal.integrated.shellArgs.windows": ["/K chcp 65001 >nul"],
    "terminal.integrated.fontFamily": "Lucida Console",
  • /K chcp 65001 >nul的含义是在运行cmd的时候将编码设置为65001;
  • >nul是避免在控制台输出修改编码的信息,否则会输出active code page: 65001
    此命令会导致终端在调试时无法正常输入输出,不建议设置

6.2、更改CMD的默认编码格式

直接修改非Unicode程序的语言为UTF8(beta)会导致所有用GBK的程序乱码,这是不可接受的。

  1. 快捷键Win+R打开运行
  2. 在运行中中通过regedit进入注册表
  3. 在注册表中找到HKEY_CURRENT_USER\Console\%SystemRoot%_system32_cmd.exe新建一个 DWORD(32位值),命名为CodePage,值设为65001 已有CodePage的话,修改它,改为:十进制的65001

注册表修改CMD的默认编码格式

同理可以在注册表中修改其他命令界面的编码格式,例如powershell,git bash……

image

其他

vscode集成终端问题

windows 10 1903/1909版本,不能使用cmd(包括cmder),git bash作为默认终端,这两个终端输入clear / cls指令后再关闭终端会造成vscode无响应.PowerShell作为默认终端时,虽然不存在clear的问题,但如果往终端输入了任何数据或指令又没有按回车就直接关闭了,同样会造成vscode无响应

WSL没有发现类似的bug

强迫症治疗

1903及以上版本windows 10,把PowersShell作为默认终端打开时,会显示一条pscore的广告--"尝试新的跨平台 PowerShell https://aka.ms/pscore6"

1803/1809版本的则会因为bug显示一堆空白
image

解决办法
唐铭:移除vscode集成终端启动时显示的多余信息

Last modification:November 25th, 2020 at 05:04 pm
如果觉得我的写的还有点意思,欢迎看官赞赏