XMake 基础

基本命令

编译

xmake

xmake build

xmake b

运行

xmake run

xmake r

打包

xmake package

xmake p

依赖管理

编辑项目根目录下的 xmake.lua

通过 add_requires() , add_packages() 添加依赖

例如

add_requires("glad", "glfw", "gtk4");
add_requires("imgui", {
    configs = {
        glfw = true,
        opengl3 = true
    }
})

target("hello")
    set_kind("binary")
    add_files("src/*.cpp")
    add_packages("glad", "glfw", "imgui", "gtk4")

让 VSCode 读取 XMake 依赖

自动生成

xmake.lua 中添加

add_rules("plugin.compile_commands.autoupdate", {outputdir = ".vscode"})

会自动在 .vscode 中生成 compile_commands.json

compile_commands (clang compilation database with json format)

也可以使用 XMake 的 VSCode 插件自动生成

但是 clangd 默认只能读取根目录下的 compile_commands.json ?

需要在 Ctrl + Shift + P 中编辑 settings.json

添加

    "clangd.arguments": [
        "--compile-commands-dir=.vscode"
    ]

这样就能自动读取 .vscode/compile_commands.json

手动生成

xmake project -k compile_commands

生成的 compile_commands.json 会被 C++ 插件读取

其中 project 命令用于生成项目文件, -k 用于选择生成的项目文件类型


XMake 基础
https://nekoside.com/archives/rang-vscode-du-qu-xmake-yi-lai
作者
nekoside
发布于
2026年01月13日
更新于
2026年01月14日
许可协议