[万字长文]Visual Studio Code 配置 C/C++ 开发环境的最佳实践(VSCode + Clangd + XMake)

%MSVC%\bin\HostX64\x64 
%WK10_BIN%\x64​
C:\Program Files\Microsoft Visual Studio\2022\Professional\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin

$ Invoke-Expression (Invoke-Webrequest 'https://xmake.io/psget.text' -UseBasicParsing).Content

$ clang --version

$ xcode-select --install

$ brew install xmake

$ /bin/zsh -c "$(curl -fsSL https://gitee.com/cunkai/HomebrewCN/raw/master/Homebrew.sh)"

$ brew install llvm

$ echo 'export PATH="/usr/local/opt/llvm/bin:$PATH"' >> ~/.zshrc
$ echo 'export LDFLAGS="-L/usr/local/opt/llvm/lib"' >> ~/.zshrc
$ echo 'export CPPFLAGS="-I/usr/local/opt/llvm/include"' >> ~/.zshrc

$ which clang
$ which clangd 
$ which lldb 

$ bash <(wget https://xmake.io/shget.text -O -)

{
    // [[Terminal]]
    "terminal.integrated.defaultProfile.osx": "zsh", // MacOS: 集成终端默认为 zsh
    "terminal.integrated.macOptionIsMeta": true, // MacOS: 将 Option 键视为终端上的元键
    "terminal.integrated.tabs.showActions": "always", // 始终显示“新建终端”按钮旁的“终端拆分”和“终止”按钮
    "terminal.integrated.tabs.showActiveTerminal": "always", // 始终显示活动终端
    "terminal.integrated.enableBell": true, // 集成终端启用视觉化铃声
    "terminal.integrated.gpuAcceleration": "on", // 集成终端使用GPU加速
    "terminal.integrated.rightClickBehavior": "selectWord", // 集成终端右击时选择光标下方的字词，并打开上下文菜单
    "terminal.integrated.defaultProfile.windows": "PowerShell",
    "terminal.integrated.env.windows": {
        "LC_ALL": "zh_CN.UTF-8" // 集成终端编码: zh_CN.UTF-8
    "terminal.integrated.profiles.windows": {
        "PowerShell": {
            "source": "PowerShell",
            "icon": "terminal-powershell"
        "Command Prompt": {
            "path": [
                "${env:windir}\\Sysnative\\cmd.exe",
                "${env:windir}\\System32\\cmd.exe"
            "args": [],
            "icon": "terminal-cmd"
        "Git Bash": {
            "source": "Git Bash"
        "Windows PowerShell": {
            "path": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
    // [[Git]]
    "git.autofetch": true, // 自动从当前 Git 存储库的默认远程库提取提交
    "git.confirmSync": false, // 同步 Git 存储库前确认
    "git.enableSmartCommit": true, // 没有暂存的更改时，直接提交全部更改
    "git.mergeEditor": true, // 启用三向合并编辑器
    "gitlens.defaultDateLocale": null,
    "gitlens.defaultDateFormat": null,
    "gitlens.defaultDateShortFormat": null,
    // [[Vim]]
    "vim.easymotion": true,
    "vim.incsearch": true,
    "vim.useSystemClipboard": true,
    "vim.useCtrlKeys": true,
    "vim.hlsearch": true,
    "vim.insertModeKeyBindings": [
            "before": [
                "j",
            "after": [
                "<Esc>"
    "vim.normalModeKeyBindingsNonRecursive": [
            "before": [
                "<leader>",
            "after": [
                "d",
            "before": [
                "<C-n>"
            "commands": [
                ":nohl"
            "before": [
            "commands": [
                "lineBreakInsert"
            "silent": true
    "vim.leader": "<space>",
    "vim.handleKeys": {
        "<C-a>": false,
        "<C-f>": false
    // [[Appearance]]
    "terminal.integrated.fontSize": 14, // 集成终端字号
    "explorer.compactFolders": false, // 资源管理器不采用紧凑模式
    "editor.fontFamily": "JetBrains Mono Medium, LXGW Bright Medium", // 编辑器全局字体
    "editor.fontLigatures": true, // 启用连字体
    "editor.fontSize": 14, // 字号
    // "editor.fontWeight": "450", // 字体粗细
    "editor.lineHeight": 0, // 行高：使用 0 根据字号自动计算行高
    "editor.bracketPairColorization.enabled": true, // 控制是否对括号着色
    "editor.bracketPairColorization.independentColorPoolPerBracketType": false, // 各类括号着色等级不独立
    "editor.guides.bracketPairs": true, // 启用括号指导线
    "editor.guides.bracketPairsHorizontal": "active", // 启用水平括号指导线
    "editor.guides.highlightActiveIndentation": false, // 禁用高亮选中的缩进指导线
    "editor.guides.indentation": false, // 禁用缩进指导线
    "editor.semanticHighlighting.enabled": true, // 启用语义高亮
    // 自定义语法高亮示例
    "editor.semanticTokenColorCustomizations": {
        "[One Dark Pro]": {
            "rules": {
                // "selfKeyword": {
                    // "foreground": "#DD94E5",
                    // "fontStyle": "italic"
                // }
    "workbench.colorTheme": "One Dark Pro", // 颜色主题
    "workbench.iconTheme": "gruvbox-material-icon-theme", // 图标主题
    "workbench.startupEditor": "none", // 在没有从上一个会话恢复出信息的情况下，在启动时不打开编辑器
    "workbench.view.alwaysShowHeaderActions": true, // 显示视图头部的操作项
    // 括号颜色
    "workbench.colorCustomizations": {
        "[One Dark Pro]": {
            "editorBracketHighlight.foreground3": "#9CDCFE",
            "editorBracketHighlight.foreground4": "#F3FD00",
            "editorBracketHighlight.foreground5": "#F47D9F",
            "editorBracketHighlight.foreground6": "#A5ADFE"
    // 针对输出窗口的部分设置
    "[plaintext]": {
        "editor.fontLigatures": false, // 不使用连字体
        "editor.formatOnSave": false, // 不在保存时自动格式化
        "editor.wordWrap": "on" // 启用自动换行
    // [[Copilot]]
    "github.copilot.enable": {
        "*": true,
        "yaml": false,
        "plaintext": true,
        "markdown": false,
        "jsonc": false,
        "cpp": false
    // [[XMake]]
    "xmake.runMode": "buildRun", // 运行前自动 build
    //




    
 "xmake.additionalConfigArguments": "--cc=clang-cl --cxx=clang-cl", // windows 可以指定 clang-cl 作为编译器
    // "xmake.debugConfigType": "codelldb", // 使用 codelldb 插件而非 cpptools 进行调试
    "xmake.buildLevel": "verbose", // 设置编译时输出信息级别,默认是warnings级别,仅输出编译警告信息以及正常信息,verbose级别输出完整的编译命令行参数,debug级别对应 xmake -vD 的诊断信息，会打印出错的栈信息
    "xmake.customDebugConfig": {
        "console": "integratedTerminal" // XMake调试时使用集成终端而非 debug console,也可以使用 externalTerminal
    "xmake.debuggingTargetsArguments": {
        "default": [
            // 啥也没有
    // [[C/C++]]
    // cpptools
    "C_Cpp.intelliSenseEngine": "Disabled", // 禁用微软 Cpptools 插件的提示功能
    "C_Cpp.codeAnalysis.runAutomatically": false,
    "C_Cpp.formatting": "Disabled",
    // clangd
    "clangd.path": "c:\\Users\\Sirius\\AppData\\Roaming\\Code\\User\\globalStorage\\llvm-vs-code-extensions.vscode-clangd\\install\\15.0.3\\clangd_15.0.3\\bin\\clangd.exe", // clangd 安装路径
    // Clangd 运行参数(在终端/命令行输入 clangd --help-list-hidden 可查看更多)
    "clangd.arguments": [
        "--all-scopes-completion", // 全局补全(补全建议会给出在当前作用域不可见的索引,插入后自动补充作用域标识符),例如在main()中直接写cout,即使没有`#include <iostream>`,也会给出`std::cout`的建议,配合"--header-insertion=iwyu",还可自动插入缺失的头文件
        "--background-index", // 后台分析并保存索引文件
        "--clang-tidy", // 启用 Clang-Tidy 以提供「静态检查」，下面设置 clang tidy 规则
        "--clang-tidy-checks=performance-*, bugprone-*, misc-*, google-*, modernize-*, readability-*, portability-*",
        "--compile-commands-dir=${workspaceFolder}/.vscode", // 编译数据库(例如 compile_commands.json 文件)的目录位置
        "--completion-parse=auto", // 当 clangd 准备就绪时，用它来分析建议
        "--completion-style=detailed", // 建议风格：打包(重载函数只会给出一个建议);还可以设置为 detailed
        // "--query-driver=/usr/bin/clang++", // MacOS 上需要设定 clang 编译器的路径，homebrew 安装的clang 是 /usr/local/opt/llvm/bin/clang++
        // 启用配置文件(YAML格式)项目配置文件是在项目文件夹里的“.clangd”,用户配置文件是“clangd/config.yaml”,该文件来自:Windows: %USERPROFILE%\AppData\Local || MacOS: ~/Library/Preferences/ || Others: $XDG_CONFIG_HOME, usually ~/.config
        "--enable-config",
        "--fallback-style=Webkit", // 默认格式化风格: 在没找到 .clang-format 文件时采用,可用的有 LLVM, Google, Chromium, Mozilla, Webkit, Microsoft, GNU
        "--function-arg-placeholders=true", // 补全函数时，将会给参数提供占位符，键入后按 Tab 可以切换到下一占位符，乃至函数末
        "--header-insertion-decorators", // 输入建议中，已包含头文件的项与还未包含头文件的项会以圆点加以区分
        "--header-insertion=iwyu", // 插入建议时自动引入头文件 iwyu
        "--include-cleaner-stdlib", // 为标准库头文件启用清理功能(不成熟!!!)
        "--log=verbose", // 让 Clangd 生成更详细的日志
        "--pch-storage=memory", // pch 优化的位置(Memory 或 Disk,前者会增加内存开销，但会提升性能)
        "--pretty", // 输出的 JSON 文件更美观
        "--ranking-model=decision_forest", // 建议的排序方案：hueristics (启发式), decision_forest (决策树)
        "-j=12" // 同时开启的任务数量
    // Clangd 找不到编译数据库(例如 compile_flags.json 文件)时采用的设置,缺陷是不能直接索引同一项目的不同文件,只能分析系统头文件、当前文件和include的文件
    "clangd.fallbackFlags": [
        "-pedantic",
        "-Wall",
        "-Wextra",
        "-Wcast-align",
        "-Wdouble-promotion",
        "-Wformat=2",
        "-Wimplicit-fallthrough",
        "-Wmisleading-indentation",
        "-Wnon-virtual-dtor",
        "-Wnull-dereference",
        "-Wold-style-cast",
        "-Woverloaded-virtual",
        "-Wpedantic",
        "-Wshadow",
        "-Wunused",
        "-pthread",
        "-fuse-ld=lld",
        "-fsanitize=address",
        "-fsanitize=undefined",
        "-stdlib=libc++",
        "-std=c++20"
    "clangd.checkUpdates": true, // 自动检测 clangd 更新
    "clangd.onConfigChanged": "restart", // 重启 clangd 时重载配置,具体方法: F1 + Fn 打开命令面板，然后搜索“clangd: restart"
    "clangd.serverCompletionRanking": true, // 借助网上的信息排序建议
    "clangd.detectExtensionConflicts": true, // 当其它拓展与 clangd 冲突时警告并建议禁用
    "editor.suggest.snippetsPreventQuickSuggestions": false, // clangd的snippets有很多的跳转点，不用这个就必须手动触发Intellisense了
    // [[LLDB]]
    "lldb.commandCompletions": true, // LLDB 指令自动补全
    "lldb.dereferencePointers": true, // LLDB 指针显示解引用内容
    "lldb.evaluateForHovers": true, // LLDB 鼠标悬停在变量上时预览变量值
    "lldb.launch.expressions": "native", // LLDB 监视表达式的默认类型
    "lldb.showDisassembly": "never", // LLDB 不显示汇编代码
    "lldb.verboseLogging": true, // LLDB 生成更详细的日志
    // [[General Settings]]
    "breadcrumbs.filePath": "on", // 控制是否及如何在“导航路径”视图中显示文件路径
    // debug
    "debug.console.acceptSuggestionOnEnter": "on", // 调试控制台中可以用 enter 接受建议
    "debug.internalConsoleOptions": "neverOpen", // 从不自动打开内部调试控制台
    // editor
    "editor.acceptSuggestionOnEnter": "on", // 编辑器中可以用 enter 接受建议
    "editor.stickyScroll.enabled": true, // 启用粘滞滚动，即显示上一级对应的代码
    "editor.wordBasedSuggestionsMode": "allDocuments", // 建议所有打开文档中的字词
    "editor.unicodeHighlight.ambiguousCharacters": false, // 不突出显示可能与基本 ASCII 字符混淆的字符
    "editor.inlayHints.enabled": "on", // 在编辑器中显示内联提示
    "editor.minimap.enabled": true, // 控制是否显示缩略图cod
    "editor.formatOnType": true, // 自动格式化
    "editor.renderWhitespace": "none", // 控制编辑器在空白字符上显示符号的方式
    "editor.snippetSuggestions": "top", // 代码片段建议置于其他建议之上
    "editor.stickyTabStops": true, // 使用空格缩进时模拟制表符的行为，可以方便对齐
    "editor.tabSize": 4, // 一个制表符 = 4个空格
    "editor.suggest.insertMode": "replace", // 建议的接受方式
    "editor.suggest.localityBonus": true, // 控制排序时是否提高靠近光标的词语的优先级
    "editor.suggest.matchOnWordStartOnly": false, // 禁用建议必须匹配开头
    "editor.suggest.shareSuggestSelections": true,
    "editor.suggest.showStatusBar": true, // 控制建议小部件底部的状态栏可见
    "editor.suggestOnTriggerCharacters": true, // 控制在键入触发字符后是否自动显示建议
    "editor.suggestSelection": "first", // 始终预先选择第一个建议
    "editor.wordBasedSuggestions": true, // 控制是否根据文档中的文字提供建议列表
    "editor.autoClosingOvertype": "always", // 控制编辑器应当自动改写左引号或右引号
    "editor.detectIndentation": false, // 禁用自动检测文件缩进模式和缩进大小，即打开文件后自动将文件更改为 VSCode 配置的缩进格式
    "editor.formatOnSave": true, // 保存自动格式化代码
    "editor.formatOnPaste": true, // 粘贴自动格式化
    "editor.quickSuggestionsDelay": 0, // 控制显示快速建议前的等待时间（毫秒）
    "editor.inlineSuggest.enabled": true, // 在编辑器中自动显示内联建议
    "editor.parameterHints.enabled": true, // 是否在输入时显示含有参数文档和类型信息的小面板
    // 控制是否在键入代码时自动显示建议
    "editor.quickSuggestions": {
        "comments": false, // 键入注释时不允许
        "other": true, // 键入其他时允许
        "strings": false // 键入字符串时不允许
    // explorer
    "explorer.confirmDragAndDrop": false, // 移动文件时无需确认
    "explorer.confirmDelete": true, // 删除文件确认
    "explorer.incrementalNaming": "smart", // 粘贴同名文件时的重命名方式;smart: 在重复名称末尾智能地添加/递增数字
    // files
    "files.autoSave": "afterDelay", // 自动保存
    "files.hotExit": "onExitAndWindowClose", // 在会话间记住未保存的文件,允许在退出编辑器时跳过保存提示 onExitAndWindowClose: 退出或窗口关闭时
    // 配置排除的文件和文件夹的glob模式,文件资源管理器将根据此设置决定要显示或隐藏的文件和文件夹
    "files.exclude": {
        "**/.classpath": true,
        "**/.factorypath": true,
        "**/.project




    
": true,
        "**/.settings": true
    "files.associations": {
        "*.pl": "prolog"
    // notebook
    "notebook.lineNumbers": "on", // 控制单元格编辑器中行号的显示
    // 应该在何处显示单元格工具栏，或是否隐藏它
    "notebook.cellToolbarLocation": {
        "default": "right", // 默认: 右边
        "jupyter-notebook": "left" // jupyter-notebook: 左边
    // search
    "search.showLineNumbers": true, // 显示搜索结果所在行号
    "search.smartCase": true, // 当搜索词为小写时，则不区分大小写进行搜索，否则区分大小写
    // 配置在搜索中排除的文件和文件夹的glob模式
    "search.exclude": {
        // "someFolder/": true,
        // "somefile": true
    // workbench
    "workbench.settings.editor": "json", // 默认打开 settings.json 进行设置
    "workbench.editor.historyBasedLanguageDetection": true, // 允许语言检测使用编辑器历史记录
    // window
    "window.restoreWindows": "all",
    "window.titleBarStyle": "native",
    "window.menuBarVisibility": "hidden",
    // output
    "output.smartScroll.enabled": true, // 输出窗口智能滚动：点击时锁定，点击最后一行时解锁
    // problems
    "problems.showCurrentInStatus": true, // 在状态栏显示当前问题
    "problems.sortOrder": "position", // 控制问题导航的显示顺序
    // other
    "security.workspace.trust.untrustedFiles": "open",
    "extensions.ignoreRecommendations": true,
    "http.proxySupport": "on",
    "[log]": {
        "editor.fontSize": 16
    "grunt.autoDetect": "on", // Grunt 任务自动检测
    "gulp.autoDetect": "on" // Gulp 任务自动检测
}

Diagnostics:
  ClangTidy:
    Add: ["*"]
    Remove:
        abseil*,
        fuchsia*,
        llvmlib*,
        zircon*,
        altera*,
        google-readability-todo,
        readability-braces-around-statements,
        hicpp-braces-around-statements,
        modernize-use-trailing-return-type,
Index:
  Background: Build

$ xmake --help

$ xmake update --integrate

$ xmake update

$ xmake create helloworld
$ cd helloworld

$ xmake # 编译
$ xmake run helloworld # 运行
Hello World!

# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language: Cpp
# BasedOnStyle: LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset: -4
# 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
AlignAfterOpenBracket: Align
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments: false
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations: false
# 右对齐逃脱换行(使用反斜杠换行)的反斜杠
AlignEscapedNewlines: Right
# 水平对齐二元和三元表达式的操作数
AlignOperands: true
# 对齐连续的尾随的注释
AlignTrailingComments: true
# 不允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine: false
# 不允许短的块放在同一行
AllowShortBlocksOnASingleLine: true
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine: true
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All
AllowShortFunctionsOnASingleLine: None
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine: true
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine: true
# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数), 
# AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType: None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings: false
# 总是在template声明后换行
AlwaysBreakTemplateDeclarations: true
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments: true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters: true
# 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:
  # class定义后面
  AfterClass: false
  # 控制语句后面
  AfterControlStatement: false
  # enum定义后面
  AfterEnum: false
  # 函数定义后面
  AfterFunction: false
  # 命名空间定义后面
  AfterNamespace: false
  # struct定义后面
  AfterStruct: false
  # union定义后面
  AfterUnion: false
  # extern之后
  AfterExternBlock: false
  # catch之前
  BeforeCatch: false
  # else之前
  BeforeElse: false
  # 缩进大括号
  IndentBraces: false
  # 分离空函数
  SplitEmptyFunction: false
  # 分离空语句
  SplitEmptyRecord: false
  # 分离空命名空间
  SplitEmptyNamespace: false
# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
BreakBeforeBinaryOperators: NonAssignment
# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似), 
#   Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似), 
#   Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
#   注：这里认为语句块也属于函数
BreakBeforeBraces: Custom
# 在三元运算符前换行
BreakBeforeTernaryOperators: false
# 在构造函数的初始化列表的冒号后换行
BreakConstructorInitializers: AfterColon
#BreakInheritanceList: AfterColon
BreakStringLiterals: false
# 每行字符的限制，0表示没有限制
ColumnLimit: 0
CompactNamespaces: true
# 构造函数的初始化列表要么都在同一行，要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth: 4
# 延续的行的缩进宽度
ContinuationIndentWidth: 4
# 去除C++11的列表初始化的大括号{后和}前的空格
Cpp11BracedListStyle: true
# 继承最常用的指针和引用的对齐方式
DerivePointerAlignment: false
# 固定命名空间注释
FixNamespaceComments: true
# 缩进case标签
IndentCaseLabels: false
IndentPPDirectives: None
# 缩进宽度
IndentWidth: 4
# 函数返回类型换行时，缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames: false
# 保留在块开始处的空行
KeepEmptyLinesAtTheStartOfBlocks: false
# 连续空行的最大数量
MaxEmptyLinesToKeep: 1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation: None
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment: Right
# 允许重新排版注释
ReflowComments: true
# 允许排序#include
SortIncludes: false
# 允许排序 using 声明
SortUsingDeclarations: false
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast: false
# 在Template 关键字后面添加空格
SpaceAfterTemplateKeyword: true
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators: true
# SpaceBeforeCpp11BracedList: true
# SpaceBeforeCtorInitializerColon: true
# SpaceBeforeInheritanceColon: true
# 开圆括号之前添加一个空格: Never, ControlStatements, Always
SpaceBeforeParens: ControlStatements
# SpaceBeforeRangeBasedForLoopColon: true
# 在空的圆括号中添加空格
SpaceInEmptyParentheses: false
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments: 1
# 在尖括号的<后和>前添加空格
SpacesInAngles: false
# 在C风格类型转换的括号中添加空格
SpacesInCStyleCastParentheses: false
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals: true
# 在圆括号的(后和)前添加空格
SpacesInParentheses: false
# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets: false
# 标准: Cpp03, Cpp11, Auto
Standard: Cpp11