善用 vs 中的错误列表和输出窗口，高效查找 C++ 多工程编译错误

前言

相信，绝大多数小伙伴儿编译 C++ 或者其它语言的程序都遇到过编译错误。今天简单总结一下如何使用错误列表（Error List） 和输出窗口（Output） 排查编译 C++ 代码产生的编译错误。简单的错误，经过错误列表就能够搞定，可是一些复杂的错误，只经过错误列表极可能是没法解决的，须要借助输出窗口的帮助。

错误列表

错误列表能够用来查看编译时的错误、警告等信息。在一条记录上双击，便可切换到对应的代码行，是咱们排查编译错误的好帮手。通常状况下，若是编译出错，错误列表会自动弹出来，若是没有弹出来，能够手动打开。

1. 打开方式

咱们能够在 View 菜单下找到 Error List，点击便可打开。对应的快捷键是 ctrl + \, e （按住ctrl，而后依次按 \ 和 e 便可）。

若是以为麻烦，仍是但愿编译出错时自动打开错误列表的话，咱们能够在Tools -> Options-> Projects and Solutions -> General 里设置。

show-error-list-when-compile-fail-setting

勾选 Always show Error List if build finishes with errors，能够在编译完成后，若是有错误，则会自动弹出 Error List 窗口。

2. 错误列表界面概览

咱们先经过一张图来了解下错误列表。

Error-List-Introduction

咱们发现有 7 列，每一列都有它的做用。

• 第 1 列：Category，以图标的形式表示信息的类型。

  • 大红叉 是真正的错误。
  • 小红叉 通常是智能提示给出的，不是真正意义上的错误。对是否能成功编译没有影响。
  • 黄色三角形+叹号 通常是警告信息。
  • 圆形+叹号 通常是提示信息。

• 第 2 列：Default Order，提示信息的编号。我没关注过。

• 第 3 列：Description ，简要描述，能够粗略判断下错误。

• 第 4 列：File ，文件。若是是头文件的话，有可能须要排查包含的此头文件的源文件。

• 第 5 列：Line ，行号。

• 第 6 列：Column ，列号。

• 第 7 列：Project，工程。提示信息关联的工程，若是项目里有多个工程，能够根据此列进行一个初步的过滤。

若是不想显示 Intellisense Error，能够右键，取消勾选 Show IntelliSense Errors。

能够根据任意一列排序（双击对应列标题便可排序），或者 右键，Sort By 选择须要排序的列。

能够显示或者隐藏任意一列，右键, Show Columns 选择须要显示/隐藏的列便可。

3. 过滤

Error List 是支持过滤的，善用过滤能够帮咱们快速找到关心的信息。

点击左侧漏洞形状的按钮旁边的下拉按钮，能够看到三种选项：

• Open Documents ：只保留与当前全部打开的文档相关的信息。

• Current Project ：只保留全部属于当前工程的信息。

• Curent Document ：只保留与当前文档相关的信息。

能够在右侧的 Search Error List 编辑框输入过滤的关键字，不过遗憾的是不支持模糊匹配和正则匹配。

下面是我录制的一个基本的过滤示例，你们能够直接感觉下。

Error-List-Filter-Demo

输出窗口

输出窗口不只能够显示各类调试信息，还能够显示编译的输出信息，好比编译错误、编译警告等。有些编译错误，仅经过错误列表不能解决，这时候咱们须要借助输出窗口的帮助。

1. 打开方式

咱们能够在 View 菜单下找到 Output，点击便可打开。对应的快捷键是 ctrl + alt + o。

若是但愿在编译时自动打开输出窗口的话，咱们能够在Tools -> Options-> Projects and Solutions -> General 里设置。

勾选 Show Output window when build starts 能够在编译开始的时候自动弹出输出窗口。能够参考错误列表打开方式的截图。

2. 简要介绍

输出窗口用法比较简单，鼠标移动到对应的按钮上就有悬浮提示，不一一介绍了。咱们能够根据 Show output from: 选项过滤不一样来源的信息。我见过如下几种：

• Build：编译产生的信息。

• Build Order：编译产生的信息，按顺序显示。

• Debug：调试输出信息。若是被调试的进程经过 OutputDebugString() 或等价的 API 输出调试信息，则会显示在此分类下。

• Source Control - Git：来自版本管理系统 Git的信息，vs 检测到当前有代码被 Git 管理，则会出现此分类。

• Source Control - Team Foundation：来自版本管理系统 Team Foundation 的信息，若是 vs 检测到当前代码被TFS 管理，则会出现此分类。

• Solution：工程加载类消息。若是某个工程加载失败，会在该分类下显示错误提示。

**说明：**若是某一行包含 path\to\file(line): 形式的信息，双击便可跳转到对应文件的特定行。

在检查编译错误时，咱们使用的是 Build 和 Build Order。其中的 Build Order 尤为有用，能够按顺序显示输出信息。试想，若是解决方案（Solution）下有不少项目（Project）的话，编译的时候，项目间的编译输出颇有可能混到一块儿，不利于咱们排查。经过 Build Order 可让输出有序。而后咱们能够按 ctrl + home 键跳转到开头，而后搜索搜索error，就能够快速找到第一条错误信息了。下面是两个使用输出窗口排查编译错误的实战。

实战

实战1. 查找头文件中的编译错误实战

下图中的编译错误，所有提示出如今头文件中。

error-in-header-file

咱们双击后会跳转到头文件。

jump-to-error-line

除了知道错误发生在第 6 行，咱们并不能获得更多有用信息了。咱们须要找到是哪一个源文件包含了这个头文件，到源文件里进一步查找缘由。这时候咱们须要切换到输出窗口了。

在输出窗口显示错误-未排序

从上图中咱们看不出来究竟是哪一个源文件包含了出问题的头文件。咱们须要切换到 Build Order，以下图：

在输出窗口显示错误-排序

咱们发现 MFCApplication2.cpp，MFCActiveXControl1.cpp 和 MFCActiveXControl2.cpp 包含了 d4d.h。咱们能够进行下一步的排查了，由于这个问题比较有意思，具体排查过程会单独写一篇文章。

实战2. 查找名字解析错误实战

下图是尝试匹配重载函数失败时，错误列表给出的错误提示。

错误列表

从提示中咱们得知，在 4 个重载函数中没有一个能匹配给定的两个参数。可是编译器具体尝试匹配了哪些函数呢？咱们没法从错误列表得知。不过咱们能够经过输出窗口查看编译器具体尝试匹配了哪些函数，以下图：

输出窗口

咱们能够发现，在咱们提供的四个重载函数中，没有一个函数能够彻底匹配给定的两个参数，编译器就懵逼了，不知道应该选择哪一个了，因此就报错了。

本例只是一个超级简单的例子，并不能很好的突出输出窗口的做用。通常涉及模板的编译错误会有一大串。这时候经过输出窗口查看具体的匹配过程就很重要了。

总结

• 善用 错误列表的过滤功能，能够帮咱们快速找到关心的信息。
• 输出窗口中的 Build Order 可让输出有序，在查找 多工程编译输出的时候，有助于咱们快速找到相关代码。
• 错误列表 + 输出窗口 + 一些设置 基本上能够解决绝大多数编译错误。

参考资料

https://docs.microsoft.com/en-us/visualstudio/ide/reference/error-list-window?view=vs-2019

https://docs.microsoft.com/en-us/visualstudio/ide/reference/output-window?view=vs-2019