如何为Neovim配置Unreal Engine 5 C++的LSP补全与格式化？

前置要求 #

• Neovim版本至少0.8，LSP支持更稳定
• 安装clangd，版本尽量和你用的Unreal内置clang版本对齐，避免参数不兼容
• 装好在Neovim里管理LSP的插件nvim-lspconfig，还有补全插件nvim-cmp（可选但强烈推荐）

步骤1：让clangd识别Unreal的编译环境 #

Unreal的C++有大量自动生成的头文件和特殊编译参数，必须让clangd拿到这些信息才能正常工作：

• 方法一：生成编译数据库（推荐）
  打开终端，切换到你的UE项目根目录，运行这条命令（替换成你的项目信息）：

  UnrealBuildTool -Project="./YourProject.uproject" -Mode=GenerateClangDatabase -Target="YourProjectEditor" -Platform=Win64
  

  执行完会在项目根目录生成compile_commands.json，clangd会自动读取这个文件里的编译参数和头文件路径。
• 方法二：手动指定参数
  如果你不想生成编译数据库，就去项目的Intermediate/Build/Win64/YourProject/Development/YourProject/BuildSettings.json里，把AdditionalCompilerArguments和IncludePaths的内容提取出来，后面配置clangd的时候填进去。

步骤2：配置nvim-lspconfig的clangd服务 #

在你的Neovim配置文件（比如~/.config/nvim/init.lua）里加这段配置：

local lspconfig = require('lspconfig')
-- 如果用nvim-cmp，就加上这句，让clangd的补全能被cmp识别
local capabilities = require('cmp_nvim_lsp').default_capabilities()

lspconfig.clangd.setup({
  capabilities = capabilities,
  cmd = {
    "clangd",
    "--header-insertion=never", -- Unreal的头文件管理特殊，别让clangd自动插头文件
    "--compile-commands-dir=" .. vim.fn.getcwd(), -- 告诉clangd编译数据库的位置
    -- 替换成你的UE安装路径里的clang++，确保驱动版本匹配
    "--query-driver=C:/Program Files/Epic Games/UE_5.3/Engine/Binaries/ThirdParty/Clang/Win64/bin/clang++",
  },
  -- 自动识别UE项目根目录（找.uproject文件或者编译数据库）
  root_dir = function(fname)
    return lspconfig.util.root_pattern("*.uproject")(fname) 
        or lspconfig.util.root_pattern("compile_commands.json")(fname)
  end,
  on_attach = function(client, bufnr)
    -- 绑定常用的LSP快捷键，按自己习惯改
    vim.keymap.set('n', 'gd', vim.lsp.buf.definition, {buffer = bufnr, desc = "跳转到定义"})
    vim.keymap.set('n', 'K', vim.lsp.buf.hover, {buffer = bufnr, desc = "查看文档"})
    
    -- 保存时自动格式化
    vim.api.nvim_create_autocmd("BufWritePre", {
      buffer = bufnr,
      callback = function()
        vim.lsp.buf.format({async = false})
      end,
    })
  end,
})

步骤3：配置自动补全（用nvim-cmp的话） #

如果装了nvim-cmp，加这段让它和clangd联动：

local cmp = require('cmp')
cmp.setup({
  sources = cmp.config.sources({
    { name = 'nvim_lsp' }, -- 用clangd提供的补全
    { name = 'buffer' }, -- 补全当前文件里的内容
  }),
  mapping = cmp.mapping.preset.insert({
    ['<CR>'] = cmp.mapping.confirm({ select = true }),
    ['<Tab>'] = cmp.mapping.select_next_item(),
    ['<S-Tab>'] = cmp.mapping.select_prev_item(),
  }),
})

验证配置 #

打开UE项目里的任意C++文件（比如YourPlayerController.cpp），等clangd加载完成：

• 输入UWorld，应该能弹出自动补全列表
• 按gd能直接跳转到UWorld的头文件定义
• 保存文件时，代码会自动按照Unreal的风格格式化

常见问题 #

• 如果clangd加载慢或者红标一堆：检查compile_commands.json是否生成正确，或者有没有把UE的Engine/Source目录加入头文件路径
• 格式化风格不对：复制UE自带的.clang-format文件到项目根目录，路径在UE安装目录/Engine/Source/Programs/UnrealBuildTool/Resources/ClangFormat

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