clangd 技术文档

安装指南

clangd 服务器

clangd 是一个语言服务器，为 C/C++ 开发提供丰富的辅助功能。如果你的系统路径中未包含 clangd，插件会在首次需要时提示下载（自动安装支持 x86-64 架构的 Linux、Windows 和 macOS 系统）。对于已安装旧版本的用户，可通过命令面板运行“检查 clangd 语言服务器更新”来进行升级。

项目配置

clangd 基于 clang 编译器，能够处理复杂的 C++ 代码结构。为了使 clangd 正确理解你的构建过程，你需要提供编译标志信息，通常这通过生成一个 compile_commands.json 文件来完成，该文件可通过多数构建系统自动生成（例如，使用 CMake 时设置 -DCMAKE_EXPORT_COMPILE_COMMANDS=1）。详细配置步骤可参考 clangd 文档中的项目设置部分。

使用说明

代码补全

当输入标识符、. 或 -> 时，会显示相关建议。利用完整 C++ 解析能力，补全结果精确且类型安全。

错误、警告及 clang-tidy 支持

实时展示代码错误和警告，采用与 clang 编译器一致的标准，并且提供一键修复选项。支持大部分 clang-tidy 检查，配置方法在 .clang-tidy 文件内进行。

跨引用导航

实现代码中的跳转定义和查找引用，基于整个项目的索引，通过快捷键 Ctrl-P # 可快速按名定位符号。

鼠标悬停与内嵌提示

悬停任一实体将展示详尽描述，或通过 Ctrl-KI 快捷键查看。内嵌提示可以临时或永久显示参数和推断类型。

包含管理

补全时自动添加所需的 #include 指令，并提示缺失的 #include。可以开启对未使用包含的警告。

格式化

利用 clang-format 引擎，支持文件或选区格式化，以及启用“按类型格式化”后每次回车后的自动格式调整。格式化风格由项目内的 .clang-format 文件控制。

重构功能

提供局部重构功能，如提取变量、函数，展开 auto 类型和宏，使用原生字符串等。通过光标选择触发代码动作菜单，如重命名操作绑定到 <F2> 键。

报告问题与贡献

clangd 属于 LLVM 项目范畴。若要参与贡献或遇到问题：

• 对于插件相关问题，报告至 vscode-clangd issues。
• 若问题是 clangd 本身所引起的，则应提交至 clangd issues。

通过上述指南，开发者可以高效地集成并利用 clangd 来增强其 C/C++ 开发体验。