MENU

VSCode 配置C/C++开发环境

• March 26, 2020 • Read: 3880 • 解决方案,知识库

1. 环境的准备

VSC只是一个纯文本编辑器(editor),不是IDE(集成开发环境),不含编译器(compiler)和许多其它功能,所以编译器要自己装好。

下载编译器

MinGW-w64 - for 32 and 64 bit Windows 往下稍微翻一下,选最新版本中的x86_64-posix-seh。

安装编译器

下下来的是一个7z的压缩包。看好bin文件夹的完整路径,我的是C:\mingw64\bin,把它加到环境变量中的PATH里去。如果你不会这一步,请百度 “如何添加环境变量”Debian系Linux用sudo apt update; sudo apt install build-essential即可。顺序不重要;路径可以不一样,反正保证gcc.exe在那个文件夹里就行验证按Win+R,运行cmd(不要跳这一步),输入gcc,应该会提示 no input files 而不是“不是内部命令或外部命令”或者“无法将 "gcc" 项识别为 cmdlet、函数、脚本文件或可运行程序的名称”。
如果是“不是内部命令或外部命令”,说明gcc在的文件夹没有在环境变量的Path中,要加进去才行。如果加了还是这样,重启。如果重启了还不行,那就是你自己进行的操作有问题。输gcc -v可以显示出gcc的版本。如果显示出来的版本与你刚下的不同/更老,说明Path里原本有老版本的编译器,可能是安装其它IDE时装上的。则需要去掉Path里原来的那一个gcc的路径。这两项验证一定要符合,否则必须修改环境变量。小心别错删了。
输入gcc -v的最后一行输出。版本要和你自己下的对应,例如64位要有x86_64和seh安装扩展(extension)C/C++:又名 cpptools,提供Debug和Format功能Code Runner:右键即可编译运行单文件,很方便,但无法Dubug。

其他可选扩展:

1.Bracket Pair Colorizer
2:One Dark Pro:大概是VS Code安装量最高的主题

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

1.GBKtoUTF8:把GBK编码的文档转换成UTF8编码的。此扩展很久没有更新了,可能有严重的bug。
2.C++ Intellisense:用的是gtags,效果非常非常一般。
3.Include Autocomplete:提供头文件名字的补全,现在cpptools和vscode-clangd都已经自带这个功能了,所以不用装。
4.C/C++ Snippets:Snippets即重用代码块,效果自己百度;这个扩展安装量虽高,不过个人感觉用处实在不大,cpptools和clangd也自带一些。

补充内容:

  • 你也可以选择其他的Snippets扩展甚至自己定义补充知识编译器是把源代码变成可执行文件的,编辑器是你打字的软件。记事本就是一个编辑器,VSC也是编辑器。编辑器是无法编译运行程序的,因为那是编译器的工作。
  • MinGW是gcc在Windows下的移植,gcc是世界上最流行的C/C++编译器组合。但gcc这个名字也指编译C语言的那个程序,g++才是C++编译器。即gcc程序和g++程序包含在gcc套件以及MinGW里,当只说gcc时要根据语境自己区分。
  • 其实MinGW和MinGW-w64只是名字像,它们是两个不同的项目。为了方便,本文中的MinGW指的其实都是MinGW-w64。MinGW本身已经很久没有更新了,不使用它哎呀,原来MinGW是活着的,但它只能产生32位程序。
  • 扩展是extension,插件是plugin,VSC用的是前者这种称呼。大部分文章都是混用两者的,不严谨但是能理解就行,要学会抓主要矛盾。

2.配置.json文件

创建一个你打算存放代码的文件夹,称作工作区文件夹;路径不能含有中文和引号,最好不要有空格,我用的是C:\VSCode-C。C和C++需要分别建立不同的文件夹,除非用虚拟工作区。不要选上一段建出来的文件夹,源代码和编译器要分开放。打开VSC,选打开文件夹;最好不要选“添加工作区文件夹”,这个就是虚拟工作区,我没用过,不保证没问题。点新建文件夹,名称为.vscode。不在资源管理里新建的原因是Windows的Explorer不允许创建的文件夹第一个字符是点(1903后才支持)。然后创建 launch.jsontasks.jsonsettings.json(不是setting.json) 放到.vscode文件夹下。
一定要在.vscode里,别变成平行的了,这几个文件的内容见下。复制以下代码出来后,知乎会自动在前面加上几行保留所有权利的字,实际使用的时候肯定要删了的。有些地方可选修改,自己对照着注释看吧。注意:如果是写C++,tasks.json的一个地方必须要修改。

launch.json代码

externalConsole可根据自己喜好修改;cwd可以是程序运行时的相对路径,如有需要可以改为${fileDirname}。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。反正这些我都加了注释,还看不懂,百度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的顺序(按字母排序)
}

3.写代码,编译,调试

建文件后就可以写代码了,c语言源代码后缀是.c,c++是.cpp或.C或.cxx(这也要我教吗……)。代码文件在保存工作区内都可以,可以自己建立文件夹,不必放到.vscode文件夹里,但路径里(包括文件名)不要含有中文和引号,最好不要有空格。
按Alt+Shift+F(或者用右键菜单)可以格式化代码,出现Intellisense的时候按tab可以补全代码。打出snippets时会出现多个跳转点,按tab可以跳到下一个去。
停止输入一小段时间(一秒)后就会有Lint,扩展会给一些建议性的warning(比如声明了变量但不使用),自己清楚就行。如果觉得不爽,也有方法不让它提示,比如去掉-Wall就会少一些。如果还想去掉更多的警告,我提示一下:-Wno-...。找好参数后可以用#pragma GCC diagnostic ignored或者加到各种Flags里。
按Ctrl+Shift+B单纯编译,按F5为编译加调试;本来ctrl+F5为运行但不调试,但现在cpptools暂不支持,还是会调试。
在写程序初期,我强烈建议不要把f5当作编译来使用,因为有的bug只会产生警告,不会阻止编译,但这些东西越早期解决越好。编译信息会在底下的“终端”面板里,如果代码有错误,点进去可以看编译器报的信息;不过因为有Lint了,平常的错误可以马上被发现和修改,写代码就轻松很多。
加断点在列号前面点一下就行,右键可以加条件断点。如果想从一开始就停下来,可以加在main函数那里,或者launch.json中有个设置。开始调试后,按f11可以一步一步进行,箭头所指的那行代码就是下一步要运行的代码;f5是一直运行到下一个断点,右键某一行代码可以选择一直运行到指定的那一行。
左边有个调试栏,可以看到变量的值,自动栏没有的可以手动添加:在代码里选中要监视的表达式,点右键有选项可以直接添加到Watch里,复杂的才需要手打。把鼠标放到变量上可以看到变量的值,但是只能识别简单的表达式。栈帧对于观察递归很有用。栈溢出和段错误时还可以抓取“异常”,自动跳转到出错的行。

清理临时exe文件

清理临时文件按照这样配置,长期编译代码下来肯定有一大堆的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

VSCode常用快捷键

  • Ctrl+鼠标左键,是文件、函数等跳转。
  • Alt + ← ,是跳转后返回原处。
  • Ctrl + Shift + O,列出函数名。
  • Ctrl + P,列出近期打开的文件名。
  • Ctrl + Tab, 可以列出最近打开的文件,在开发时,两个文件间切换时效率很高。

上述是最常用的功能。其他功能请参考VSCode 官网快捷键要注意下,在windows下,上述快捷是默认的.但在linux、mac下, Alt + ← 跳转返回原处 这一快捷键是无法使用的,原因是快捷键冲突。

作者:谭九鼎
链接:https://www.zhihu.com/question/30315894/answer/154979413
来源:知乎
文章内容有删改优化

版权属于:字节星球/肥柴之家 (转载请联系作者授权)
原文链接:https://www.bytecho.net/archives/vscode-cpp.html
本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。

Last Modified: September 21, 2023
Archives QR Code
QR Code for this page
Tipping QR Code
Leave a Comment

2 Comments
  1. zdhs zdhs IP属地:广西     Windows 7    Google Chrome

    淘宝刷单单号 物流刷单单号 快递代发www.**.cn

    1. Henry Henry     Windows 10+    Google Chrome

      @zdhs公开处刑:刷广告者没?。