在 VS Code 中尝试 ！

编辑和导航 C++ 代码

本文概述了 C/C++ 扩展中特定的代码编辑和导航功能。有关 Visual Studio Code 中常规编辑和导航的更多信息，请参阅基本编辑和代码导航。

编辑 C++ 代码

C/C++ 扩展提供的源代码编辑功能是编辑、格式化和理解代码库的强大工具。

识别头文件

为了提供最佳的编辑体验，C++ 扩展需要知道在哪里查找代码中引用的每个头文件。默认情况下，扩展会搜索当前源目录、其子目录以及一些平台特定的位置。如果找不到引用的头文件，则会在 #include 指令下方显示红色波浪线。

要指定附加的包含目录，

  1. 选择没有引用的 #include 路径。
  2. 选择出现的灯泡图标，然后选择Edit "includePath" setting，这将打开 C/C++ 扩展的设置编辑器。
  3. 在包含路径部分下，可以指定任何附加包含目录的路径。

Process of adding a new header to the include path

列出成员

键入成员访问符号（. 或 ->）时，编辑器会显示成员列表。键入更多字母时，列表会实时过滤

List members

代码格式化

Visual Studio Code 的 C/C++ 扩展支持使用 clang-format 和 vc_format 进行源代码格式化。这两种格式化选项都包含在扩展中，其中 clang-format 是默认选项。

可以使用右键单击上下文菜单中的格式化文档 (⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I)) 格式化整个文件，或使用格式化选定内容 (⌘K ⌘F (Windows, Linux Ctrl+K Ctrl+F)) 格式化当前选定内容。还可以使用以下设置根据用户手势触发格式化，例如键入、保存和粘贴

  • editor.formatOnSave - 在保存文件时进行格式化。
  • editor.formatOnType - 在键入时进行格式化（在字符 ; 触发）。

要了解有关格式化的更多信息，请参阅格式化。

Clang-format

默认情况下，clang-format 样式设置为 file。这意味着如果在工作区中找到 .clang-format 文件，则文件中指定的设置将用作格式化参考。否则，格式化将基于 C_Cpp.clang_format_fallbackStyle 设置中指定的默认样式。

目前，默认的格式化样式是 Visual Studio，它是 Visual Studio 中默认代码格式化程序的近似值。它意味着以下设置

UseTab: (VS Code current setting)
IndentWidth: (VS Code current setting)
BreakBeforeBraces: Allman
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
ColumnLimit: 0

要使用与扩展附带的 clang-format 不同版本，请将 C_Cpp.clang_format_path 设置更改为安装 clang-format 二进制文件的路径。

例如，在 Windows 平台上，使用

  "C_Cpp.clang_format_path": "C:\\Program Files (x86)\\LLVM\\bin\\clang-format.exe"

vc_format

默认情况下，如果在被格式化的代码附近找到包含相关设置的 .editorconfig 文件，则会使用 Visual C++ 格式化引擎而不是 clang-format。否则，导航到 C_Cpp.formatting 设置并将其设置为 vc_format 以使用 Visual C++ 格式化引擎。

增强的语义着色

启用 IntelliSense 后，Visual Studio Code C/C++ 扩展支持语义着色。有关设置类、函数、变量等颜色的更多信息，请参阅增强的着色。有关配置 IntelliSense 的更多信息，请参阅IntelliSense 配置。

快速信息

可以将鼠标悬停在符号上以查看其定义的内联视图

Quick info

Doxygen 注释

Doxygen 是一种从源代码生成文档的工具。使用注释标注代码后，Doxygen 会为这些函数生成文档。对于 doxygen 注释，键入 /** 并按 Enter 键以生成 doxygen 注释块。支持的 doxygen 标记包括：@brief、@tparam、@param、@return、@exception、@deprecated、@note、@attention 和 @pre。

Markdown 注释

默认情况下，C++ 扩展支持在编辑器中显示 Markdown 的一个子集。此子集支持除符号 _ 和 * 之外的所有 Markdown 注释。切换新的Markdown in Comments 设置以启用所有 Markdown、保留此 Markdown 子集或禁用 Markdown 支持。

导航源代码

源代码导航功能可以帮助您更好地理解代码库。它们使您可以快速搜索代码中的符号、导航到其定义或查找对它们的引用。

导航由存储在符号信息本地数据库中的一组标记提供支持。每当打开包含 C++ 源代码文件的文件夹时，C/C++ 扩展都会创建这些文件中定义的符号数据库。此数据库会在文件更改时更新。如果文档在未保存的情况下关闭，则数据库会更新到上次保存的状态。

搜索符号

您可以在当前文件或工作区中搜索符号，以更快地导航代码。

要在当前文件中搜索符号，请按 ⇧⌘O (Windows, Linux Ctrl+Shift+O)，然后输入要查找的符号名称。将出现一个潜在匹配项列表，该列表会随着您的键入而进行筛选。从匹配项列表中选择以导航到该符号的位置。

Searching the current file

要在当前工作区中搜索符号，请按 ⌘T (Windows, Linux Ctrl+T)，然后输入符号名称。将出现一个潜在匹配项列表。如果您选择的匹配项位于尚未打开的文件中，则会在导航到匹配项位置之前打开该文件。

Searching in your workspace

还可以通过命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 访问这些命令来搜索符号。使用快速打开 (⌘P (Windows, Linux Ctrl+P))，然后输入命令 @ 以搜索当前文件，或输入命令 # 以搜索当前工作区。⇧⌘O (Windows, Linux Ctrl+Shift+O) 和 ⌘T (Windows, Linux Ctrl+T) 是 @ 和 # 命令的快捷方式。

调用层次结构

调用层次结构视图显示了对某个函数的所有调用或来自某个函数的所有调用。它使您能够理解源代码中函数之间复杂的调用关系。

要查看调用层次结构，请选择一个函数，右键单击以显示上下文菜单，然后选择显示调用层次结构。您还可以使用键盘快捷方式（Windows 上为 Shift+Alt+H），或调用命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 并运行命令 Calls: Show Call Hierarchy。这将在侧栏中填充由您选定的函数调用的所有函数的调用树。

Selecting call hierarchy and showing calls in sidebar

切换侧栏菜单中的电话图标以切换到传入调用。当您的函数被其他函数引用时，将显示传入调用。您还可以通过选择调用树中已显示的函数并右键单击该函数来查看可用命令，从而探索嵌套调用。

Nested Calls for Call Hierarchy

速览

速览功能在速览窗口中显示几行代码，这样您就不必离开当前位置。这对于快速了解符号的上下文而无需离开当前代码非常有用。

要打开速览窗口，请右键单击导航到上下文菜单，然后选择速览。在此处，您可以选择速览符号的定义、声明、类型定义或引用。

Peek definition

打开速览窗口后，您可以浏览显示的结果列表以找到您感兴趣的结果。如果要导航到其中一个结果的位置，请选择该结果或双击速览窗口左侧显示的源代码。

转到定义

使用转到定义功能快速导航到源代码中定义符号的位置。在源代码中选择一个符号，然后按 F12，或右键单击并从上下文菜单中选择转到定义。当符号只有一个定义时，您将直接导航到其位置，否则会在速览窗口中显示相互竞争的定义，如上一节所述。

如果找不到您选择的符号的定义，C/C++ 扩展会自动搜索该符号的声明。

转到声明

使用转到声明功能导航到源代码中声明符号的位置。此功能与转到定义功能相同，但用于声明。在源代码中选择一个符号，右键单击，然后从上下文菜单中选择转到声明。这将导航到符号声明的位置。

转到引用

使用转到引用功能了解符号在源代码中被引用的频率和位置。在源代码中选择一个符号，然后按 ⇧F12 (Windows, Linux Shift+F12) 或右键单击并从上下文菜单中选择转到引用。如果找到任何引用，它们将显示在速览窗口中。

转到类型定义

使用转到类型定义功能跳转到源代码中定义类型的位置。在源代码中选择一个类型，右键单击打开上下文菜单，然后选择转到类型定义。

后续步骤

继续阅读以了解有关以下内容的信息

如果您有任何其他问题或遇到任何问题，请在 GitHub 上提交议题。您可能需要提供扩展的日志信息以帮助诊断问题。有关提供扩展日志的帮助，请参阅 C/C++ 扩展日志记录。

1/16/2024