参加你附近的 ,了解 VS Code 中的 AI 辅助开发。

编辑和导航 C++ 代码

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

编辑 C++ 代码

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

识别头文件

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

要指定其他包含目录,

  1. 选择一个没有引用的 #include 路径。
  2. 选择出现的小灯泡图标,然后选择 编辑 "includePath" 设置 (Edit "includePath" setting),这将打开 C/C++ 扩展的设置编辑器。
  3. 包含路径 (Include Path) 部分,您可以为任何其他包含目录指定路径。

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 (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) 分别是 @# 命令的快捷键。

调用层级

调用层级视图显示了对一个函数的所有调用或从该函数发出的所有调用。它能让您理解源代码中函数之间复杂的调用关系。

要查看调用层级,请选择一个函数,右键单击以显示上下文菜单,然后选择显示调用层级 (Show Call Hierarchy)。您也可以使用键盘快捷键(在 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)。在这里,您可以选择速览符号的定义、声明、类型定义或引用。

Peek definition

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

转到定义

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

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

转到声明

使用转到声明 (Go to Declaration) 功能可以导航到符号在源代码中声明的位置。此功能与转到定义的功能相同,但作用于声明。在源代码中选择一个符号,右键单击,然后从上下文菜单中选择转到声明。这将把您导航到该符号声明的位置。

转到引用

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

转到类型定义

使用转到类型定义 (Go to Type Definition) 功能可以跳转到类型在源代码中定义的位置。在源代码中选择一个类型,右键单击打开上下文菜单,然后选择转到类型定义

后续步骤

继续阅读以了解:

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