Visual Studio Debugger如何为C/C++结构体注册自定义显示格式

你可以通过编写Natvis配置文件实现自定义结构体的调试展示效果，步骤如下：

• 第一步：创建后缀为.natvis的配置文件，比如CustomCStruct.natvis，可以直接把文件添加到当前项目中，也可以放到VS用户可视化目录%USERPROFILE%\Documents\Visual Studio 20xx\Visualizers下，VS调试时会自动识别加载。
  适配你给出的VEC结构体的Natvis配置示例如下：

  <?xml version="1.0" encoding="utf-8"?>
  <AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
    <Type Name="VEC">
      <!-- 单行展示的内容，和std::vector默认展示逻辑一致 -->
      <DisplayString>{{size = {DataEnd_ - DataBegin_}, capacity = {MemEnd_ - DataBegin_}}}</DisplayString>
      <Expand>
        <!-- 展开后优先展示大小、容量字段 -->
        <Item Name="[size]">DataEnd_ - DataBegin_</Item>
        <Item Name="[capacity]">MemEnd_ - DataBegin_</Item>
        <!-- 告诉调试器把DataBegin_当做数组首地址，长度为元素总数 -->
        <ArrayItems>
          <Size>DataEnd_ - DataBegin_</Size>
          <ValuePointer>DataBegin_</ValuePointer>
        </ArrayItems>
      </Expand>
    </Type>
  </AutoVisualizer>
  

  如果你的VEC结构体定义在命名空间内，需要把Type标签的Name属性改为命名空间::VEC的完整格式。
• 第二步：确认调试选项开启，打开VS的工具-选项-调试-常规，确保启用Natvis可视化选项处于勾选状态（默认是开启的），重启调试即可生效，此时查看VEC类型变量就会和std::vector一样直接展示数组元素。

std::vector没有使用任何调试器专属的pragma指令或者特殊编译配置：

• Visual Studio安装时会自带一套内置的Natvis配置文件，默认路径为VS安装目录\Common7\Packages\Debugger\Visualizers，其中的stl.natvis就定义了所有STL容器的调试展示规则，格式和你自己编写的自定义Natvis文件完全一致。
• 调试器启动时会自动加载系统内置、用户目录、当前项目中所有的Natvis文件，遍历待展示的变量类型，匹配到对应规则就按照规则渲染变量视图，没有匹配到的类型就会默认展示所有成员变量。
• 其他调试器也有类似的逻辑：GDB用Python编写的Pretty Printer定义自定义展示规则，LLDB用类型摘要脚本实现，本质都是调试器不内置特定类型的展示逻辑，由外置配置文件来匹配规则，STL的展示效果就是标准库随工具链发布的配套配置实现的。

内容的提问来源于stack exchange，提问作者modanashar