Visual Studio Code 编写运行 C、C++ 程序

01.前言

某个软件工程的师弟让我帮忙装Visual Studio Code……觉得挺像微软的,谷歌了一下,真的是微软的。。。。

 

环境的准备

VSC的官网、下载、安装,我就不多说了。VSC只是一个纯文本编辑器(editor),不是IDE(集成开发环境),不含编译器(compiler)和许多其它功能,所以编译器要自己装好。

其实MinGW和MinGW-w64只是名字像,它们是两个不同的项目。为了方便,本文中的MinGW指的其实都是MinGW-w64。MinGW本身已经很久没有更新了,故不推荐。下载以下两个程序(都要):

  • LLVM Download Page 在此页面下载Clang。选 Pre-Built Binaries 中的 Windows (64-bit),不需要下.sig文件
  • MinGW-w64 - for 32 and 64 bit Windows 在此页面下载 MinGW-w64,往下稍微翻一下,选最新版本中的x86_64-posix-seh。最好不要用 Download Latest Version,这个是在线安装包,可能因为国内的“网络环境”下载失败。如果浏览器下载失败就换迅雷下或者连手机开的热点下,还失败,那就使用能访问Google的那种方法下

安装Clang:添加环境变量时,选 Add LLVM to the system PATH for all users(即第二项,不过第三项也差不多);路径我填的是 C:\LLVM,也可以保持默认或者自己改。

安装MinGW-w64:下下来的是一个7z的压缩包。如果你懂怎么添加环境变量,解压到想要的位置后直接把gcc.exe所在的bin文件夹加到Path里即可。如果不懂,随便解压到一个地方,把东西全部复制或者直接剪切到Clang的文件夹里去,它们会无冲突合并,然后就可以把它删了,这样做(如果下面的验证通过)就可以不改环境变量:

懂怎么添加Path就不用做这一步

验证

运行cmd,输clang或gcc,应该会提示 no input files 而不是“不是内部命令或外部命令”或者“无法将“clang”项识别为 cmdlet、函数、脚本文件或可运行程序的名称”,见下图。如果是“不是内部命令或外部命令”,说明clang.exe在的文件夹(我图里的是 C:\LLVM\bin)没有在环境变量中,要加到Path里才行。如果加了还是这样,重启。

clang -vgcc -v可以显示出各自的版本。如果显示出来的版本与你刚下的不同/更老,说明Path里原本有老版本的编译器,可能是安装其它IDE时装上的。则需要去掉Path里原来的那一个gcc的路径。

这两项验证一定要符合,clang和gcc都要有,否则必须修改环境变量,把它们加到Path里去。如果你不知道怎么修改环境变量可以自己百度或者b站搜“环境变量”看视频。大多不是C的但是区别不大,小心别错删了就是。

输入gcc -v的最后一行输出。版本要和你自己下的对应,要有x86_64和seh

安装扩展(extension)

必装:

  • C/C++:又名 cpptools,提供Debug和Format功能
  • vscode-clangd:提供Intellisense和Lint功能;仓库见:clangd/clangd
  • Code Runner:右键即可编译运行单文件,很方便;但无法Dubug

其他可选扩展:

  • Bracket Pair Colorizer 2:彩虹花括号
  • One Dark Pro:大概是VS Code安装量最高的主题
  • C/C++ Clang Command Adapter:是本文前一个版本选择的扩展,vscode-clangd出现问题时可以考虑换成这个试试;配置有一些不同,需要改clang.cflags;如果没出问题就别装了
  • Clang-Format:只有想自定义代码风格时才装,比如大括号不换行。需要另外学习如何使用
  • CodeLLDB:lldb的vscode扩展,需要Python环境;我没用过

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

  • 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++需要分别建立不同的工作区,除非你已经掌握了一定程度的知识。

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

特别提示:默认F5只能编译调试C,如果你要调试C++,必需改tasks.json中的第一点;而且要修改compile_flags.txt。具体参见小节说明,其它的如果实在看不懂,保持默认就好。

复制以下代码出来后,知乎会自动在前面加上几行保留所有权利的字,实际使用的时候肯定要删了的。

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++,编译器需改成clang++;如果想用MinGW就分别是gcc和g++,但注意把--target那条删去。

如果不想要额外警告,把-Wall那一条删去;-std根据自己需要修改。

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

args的参数的作用我加了注释,还看不懂,百度gcc使用教程。

// https://code.visualstudio.com/docs/editor/tasks
{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Compile", // 任务名称,与launch.json的preLaunchTask相对应
            "command": "clang", // 要使用的编译器,C++用clang++;如果编译失败,改成gcc或g++试试,还有问题那就是你自己的代码有错误
            "args": [
                "${file}",
                "-o", // 指定输出文件名,不加该参数则默认输出a.exe,Linux下默认a.out
                "${fileDirname}/${fileBasenameNoExtension}.exe",
                "-g", // 生成和调试有关的信息
                "-Wall", // 开启额外警告
                "-static-libgcc", // 静态链接libgcc,一般都会加上
                "--target=x86_64-w64-mingw", // clang的默认target为msvc,不加这一条就会找不到头文件;用gcc或者Linux则掉这一条
                // "-std=c11", // C++最新标准为c++17,或根据自己的需要进行修改
            ], // 编译命令参数
            "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" // 此选项可以捕捉编译时终端里的报错信息;本文用的是clang,开了可能会出现双重报错信息;只用cpptools可以考虑启用
        }
    ]
}

settings.json代码

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

Code Runner的命令行和某些选项可以根据自己的需要在此处修改,用法还是参见此扩展的文档和百度gcc使用教程。Win7需要改用注释掉的命令行,或者把terminal.integrated.shell.windows改为PowerShell。

Linux下记得去掉--target那个参数。

 

{
    "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 && clang '$fileName' -o '$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc --target=x86_64-w64-mingw -std=c11 && &'$dir$fileNameWithoutExt'",
        "cpp": "cd $dir && clang++ '$fileName' -o '$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc --target=x86_64-w64-mingw -std=c++17 && &'$dir$fileNameWithoutExt'"
        // "c": "cd $dir && clang $fileName -o $fileNameWithoutExt.exe -Wall -g -O2 -static-libgcc --target=x86_64-w64-mingw -std=c11 && $dir$fileNameWithoutExt",
        // "cpp": "cd $dir && clang++ $fileName -o $fileNameWithoutExt.exe -Wall -g -O2 -static-libgcc --target=x86_64-w64-mingw -std=c++17 && $dir$fileNameWithoutExt"
    }, // 控制Code Runner命令;未注释的仅适用于PowerShell(Win10默认),文件名中有空格也可以编译运行;注释掉的适用于cmd(win7默认),也适用于PS,文件名中有空格时无法运行
    "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的顺序(按字母排序)
    "C_Cpp.errorSquiggles": "Disabled", // 因为有clang的lint,所以关掉;如果你看的是别的答主用的不是vscode-clangd,就不要加这个了
    "C_Cpp.autocomplete": "Disabled", // 同上;这几条也可以考虑放到全局里,否则很多错误会报两遍,cpptools一遍clangd一遍
    "C_Cpp.suggestSnippets": false, // 同上
}


 

compile_flags.txt

此文件对于本文的配置是必须创建的,且一定要是这个文件名,大小写要也一样。位置需要在你的工作区文件夹的磁盘根目录。

例如你选择的工作区文件夹在C盘里(任何位置),那就需要创建一个C:\compile_flags.txt。可以先在桌面上创建这个txt,再复制/拖拽到C盘根目录去(因为有UAC限制无法直接创建);另外如果你的后缀是隐藏的,最好打开一下,自己百度。


-Wall
--target=x86_64-w64-mingw
#-std=c++17
#如果写C++,就去掉上面一行最开头的井号 

(以下四行如果看不懂就不用管)

此文件是clangd为了提供必须的功能所使用的,效果和直接把它们传递给clang.exe差不多。感兴趣的可以参见:https://clangd.github.io/。其他大多数教程(其实是我见过的其它所有教程)因为没有选择使用clangd所以没创建这个文件。

clangd只会使用离要评估的文件最近的一个compile_flags.txt。对于我来说,我还创建了C:\VS-Code-C\compile_flags.txtC:\VS-Code-CPP\compile_flags.txt,再在前者里加一行-std=c11和在后者里加-std=c++17来使用最新的标准。这样可以覆盖general的配置,缺点是这样代码列表里会多一个文件。

将此文件放在根目录是确保--target参数是存在的,是最后的fallback,否则就报找不到头文件的错误,Lint也几乎没用。 此参数的作用可以直接在本文内搜索,提了很多次。

比较坑的是,C和C++都会使用.h作为头文件,如果不加任何std,.c和.cpp能正确lint,但是.h会使用C的模式。对于fallback来说感觉没什么好办法,只能靠大家手动指定了。

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

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

为什么要往json里写这么多的东西?因为VSC本身并没有对C语言特别优待,对其他许多语言也一样。另一个原因是我没用过lldb,就必须使用cpptools加gdb来调试,两个扩展有一些功能重复,导致配置变得复杂。

以$开头的是VSC预定义的变量,具体参见:Variables Reference。比如$file在实际运行时会替换成当前打开的文件名。

3. 写代码,编译,调试

新建文件后就可以写代码了,c语言源代码后缀是.c,c++是.cpp或.C或.cxx(这也要我教吗……)。代码文件在保存工作区内都可以,可以自己建立文件夹,不必放到.vscode文件夹里,但路径里(包括文件名)不要含有中文和引号,最好不要有空格。(主要是许多符号是有效的shell语法,不然试试Linux下用rm删除一个叫做-rf的文件?没查过绝对写不出来)

按Alt+Shift+F(或者用右键菜单)可以格式化代码,第一次用的时候右下角会提示选择格式化提供程序,如果你喜欢大括号换行就选C/C++,喜欢不换行就选vscode-clangd。出现Intellisense的时候按tab可以补全代码。打出snippets时会出现多个跳转点,按tab可以跳到下一个去。

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

按Ctrl+Shift+B单纯编译,按F5为编译加运行加调试;本来ctrl+F5为运行但不调试,但现在cpptools暂不支持,还是会调试。Follow: How to launch an application without debugging? · Issue #1201 · Microsoft/vscode-cpptools

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

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

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

特别的,对于数组:C语言的数组经过函数传递以后会退化为指针,直接添加表达式就只能看到第一个元素。此时可以强制转换成指向固定大小的数组指针再解引。例如int arr[10]传进函数里后就变成了int* arr,此时可以添加*(int(*)[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和compile_flags.txt里来配置Intellisense。

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

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

保存文件夹

以后写代码必须打开之前那个建立好的文件夹才能写,否则所有的Intellisense都没有,只有Code Runner能用。

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

 

部分转自知乎:谭九鼎

发表评论

表情(⊙o⊙)…
看不清楚?点图切换 Ctrl+Enter快速提交

网友评论(0)

sitemap