C++

Zed 原生支持 C++。

二进制文件

您可以配置 Zed 应该使用哪个 clangd 二进制文件。

默认情况下,Zed 会尝试在您的 $PATH 中查找 clangd 并尝试使用它。如果该二进制文件成功执行,则使用它。否则,Zed 将回退到安装其自己的 clangd 版本并使用它。

如果您想安装预发布版 clangd,可以通过在 settings.json 中将 pre_release 设置为 true 来指示 Zed 执行此操作

{
  "lsp": {
    "clangd": {
      "fetch": {
        "pre_release": true
      }
    }
  }
}

如果您想禁用 Zed 查找 clangd 二进制文件,可以在 settings.json 中将 ignore_system_version 设置为 true

{
  "lsp": {
    "clangd": {
      "binary": {
        "ignore_system_version": true
      }
    }
  }
}

如果您想使用自定义位置的二进制文件,可以指定 path 和可选的 arguments

{
  "lsp": {
    "clangd": {
      "binary": {
        "path": "/path/to/clangd",
        "arguments": []
      }
    }
  }
}

"path" 必须是绝对路径。

参数

您可以向 clangd 传递任意数量的参数。要查看所有可用选项,请从命令行运行 clangd --help。例如,使用 --function-arg-placeholders=0 时,函数调用的自动补全只包含括号,而默认(--function-arg-placeholders=1)的自动补全也包含方法参数的占位符。

{
  "lsp": {
    "clangd": {
      "binary": {
        "path": "/path/to/clangd",
        "arguments": ["--function-arg-placeholders=0"]
      }
    }
  }
}

格式化

默认情况下,Zed 将使用 clangd 语言服务器来格式化 C++ 代码。Clangd 与 clang-format CLI 工具相同。要配置此功能,您可以添加一个 .clang-format 文件。例如:

---
BasedOnStyle: LLVM
IndentWidth: 4
---
Language: Cpp
# Force pointers to the type for C++.
DerivePointerAlignment: false
PointerAlignment: Left
---

有关选项的完整列表,请参阅 Clang-Format 样式选项

您可以通过 cmd-shift-i|ctrl-shift-i 或命令面板中的 editor: format 操作,或通过在 Zed 设置中添加 format_on_save 来触发格式化

  "languages": {
    "C++": {
      "format_on_save": "on",
      "tab_size": 2
    }
  }

更多服务器配置

在项目根目录中,通常会创建一个 .clangd 文件来设置额外的配置。

CompileFlags:
  Add:
    - "--include-directory=/path/to/include"
Diagnostics:
  MissingIncludes: Strict
  UnusedIncludes: Strict

有关 clangd 配置文件的更高级用法,请参阅其官方页面

编译命令

对于某些项目,Clangd 需要一个 compile_commands.json 文件才能正确分析您的项目。此文件包含编译数据库,它告诉 clangd 如何构建您的项目。

CMake 编译命令

使用 CMake,您可以通过在 CMakeLists.txt 中添加以下行来自动生成 compile_commands.json

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

构建项目后,CMake 将在构建目录中生成 compile_commands.json 文件,clangd 将自动拾取它。

调试

您可以使用 CodeLLDB 或 GDB 调试原生二进制文件。(请确保您的构建过程将 -g 传递给 C++ 编译器,以便调试信息包含在生成的二进制文件中。)有关您可以添加到 .zed/debug.json 的调试配置示例,请参见下文。

构建和调试二进制文件

[
  {
    "label": "Debug native binary",
    "build": {
      "command": "make",
      "args": ["-j8"],
      "cwd": "$ZED_WORKTREE_ROOT"
    },
    "program": "$ZED_WORKTREE_ROOT/build/prog",
    "request": "launch",
    "adapter": "CodeLLDB"
  }
]