VSCode + MSYS2 + Clang + Clangd + Xmake 配置优雅的 Windows C++ 开发环境

1
// Xmake
2
"xmake.debugConfigType": "codelldb", // 使用 codelldb 插件而非 cpptools 进行调试
3
"xmake.runMode": "buildRun", // 运行前自动 build
4
"xmake.buildLevel": "verbose", // 设置编译时输出信息级别,默认是warnings级别,仅输出编译警告信息以及正常信息,verbose级别输出完整的编译命令行参数,debug级别对应 xmake -vD 的诊断信息，会打印出错的栈信息
5
"xmake.customDebugConfig": {
6
    "console": "integratedTerminal" // XMake调试时使用集成终端而非 debug console,也可以使用 externalTerminal
7
},
8
// Clangd
9
"clangd.path": "C:/msys64/clang64/bin/clangd.exe", // Clangd 文件位置
10
"clangd.arguments": [
11
  "--all-scopes-completion", // 全局补全(补全建议会给出在当前作用域不可见的索引,插入后自动补充作用域标识符),例如在main()中直接写cout,即使没有`#include <iostream>`,也会给出`std::cout`的建议,配合"--header-insertion=iwyu",还可自动插入缺失的头文件
12
  "--background-index", // 后台分析并保存索引文件
13
  "--clang-tidy", // 启用 Clang-Tidy 以提供「静态检查」
14
  "--clang-tidy-checks=performance-*, bugprone-*, misc-*, google-*, modernize-*, readability-*, portability-*",
15
  "--compile-commands-dir=${workspaceFolder}/.vscode", // 编译数据库(compile_commands.json 文件)的目录位置
16
  "--completion-parse=auto", // 当 clangd 准备就绪时，用它来分析建议
17
  "--completion-style=detailed", // 建议风格：打包(重载函数只会给出一个建议);还可以设置为 detailed
18
  "--enable-config", // 启用配置文件(YAML格式)
19
  "--fallback-style=LLVM", // 默认格式化风格: 在没找到 .clang-format 文件时采用,可用的有 LLVM, Google, Chromium, Mozilla, Webkit, Microsoft, GNU
20
  "--function-arg-placeholders=true", // 补全函数时，将会给参数提供占位符，键入后按 Tab 可以切换到下一占位符，乃至函数末
21
  "--header-insertion-decorators", // 输入建议中，已包含头文件的项与还未包含头文件的项会以圆点加以区分
22
  "--header-insertion=never", // 插入建议时不自动引入头文件
23
  "--log=verbose", // 让 Clangd 生成更详细的日志
24
  "--pch-storage=memory", // pch 优化的位置(Memory 或 Disk,前者会增加内存开销，但会提升性能)
25
  "--pretty", // 输出的 JSON 文件更美观
26
  "--ranking-model=decision_forest", // 建议的排序方案：hueristics (启发式), decision_forest (决策树)
27
  "-j=12", // 同时开启的任务数量
28
  "--query-driver=C:/msys64/clang64/bin/clang*" // clang 编译器的路径（设置错误会导致 clangd 无法识别标准库）
29
],
30
"clangd.checkUpdates": true, // 自动检测 clangd 更新
31
"clangd.onConfigChanged": "restart", // 借助网上的信息排序建议
32
"clangd.detectExtensionConflicts": true, // 当其它拓展与 clangd 冲突时警告并建议禁用
33
"editor.suggest.snippetsPreventQuickSuggestions": false, // clangd的snippets有很多的跳转点，不用这个就必须手动触发Intellisense了
34
// LLDB
35
"lldb.commandCompletions": true, // LLDB 指令自动补全
36
"lldb.dereferencePointers": true, // LLDB 指针显示解引用内容
37
"lldb.evaluateForHovers": true, // LLDB 鼠标悬停在变量上时预览变量值
38
"lldb.launch.expressions": "native", // LLDB 监视表达式的默认类型
39
"lldb.showDisassembly": "never", // LLDB 不显示汇编代码
40
"lldb.verboseLogging": true,

1
Diagnostics:
2
  ClangTidy:
3
    Add: [readability-identifier*]
4
    CheckOptions:
5
      # 变量命名规则
6
      # 详细请参考官方文档 https://clang.llvm.org/extra/clang-tidy/checks/readability/identifier-naming.html
7
      readability-identifier-naming.VariableCase: lower_case
8
      readability-identifier-naming.GlobalVariableCase: lower_case
9
      readability-identifier-naming.GlobalVariablePrefix: g_
10

11
      readability-identifier-naming.MemberPrefix: m_
12
      readability-identifier-naming.MemberCase: lower_case
13
      readability-identifier-naming.ClassMemberPrefix: m_
14
      readability-identifier-naming.ClassMemberCase: lower_case
15

16
      readability-identifier-naming.EnumCase: UPPER_CASE
17
      readability-identifier-naming.EnumConstantCase: UPPER_CASE
18
      readability-identifier-naming.MacroDefinitionCase: UPPER_CASE
19

20
      readability-identifier-naming.ClassCase: CamelCase
21
      readability-identifier-naming.StructCase: Camelcase
22

23
      readability-identifier-naming.FunctionCase: camelCase
24
      readability-identifier-naming.ClassMethodCase: camelCase
25
      readability-identifier-naming.MethodCase: camelCase
26

27
      readability-identifier-naming.ConstantCase: UPPER_CASE
28
      readability-identifier-naming.ConstantParameterCase: camel_Snake_Back
29

30
CompileFlags:
31
  Add:
32
    - '-pedantic'
33
    - '-Wall'
34
    - '-Wextra'
35
    - '-Wcast-align'
36
    - '-Wdouble-promotion'
37
    - '-Wformat=2'
38
    - '-Wimplicit-fallthrough'
39
    - '-Wmisleading-indentation'
40
    - '-Wnon-virtual-dtor'
41
    - '-Wnull-dereference'
42
    - '-Wold-style-cast'
43
    - '-Woverloaded-virtual'
44
    - '-Wpedantic'
45
    - '-Wshadow'
46
    - '-Wunused'
47
    - '-pthread'
48
    - '-fuse-ld=lld'
49
    - '-fsanitize=address'
50
    - '-fsanitize=undefined'
51
    - '-stdlib=libc++'
52
    - '-std=c++20' # 根据实际需要填写

1
---
2
Checks: "bugprone-*,\
3
  google-*,\
4
  misc-*,\
5
  modernize-*,\
6
  performance-*,\
7
  readability-*,\
8
  portability-*,\
9
  "
10
HeaderFilterRegex: 'Source/cm[^/]*\.(h|hxx|cxx)$'
11
CheckOptions:
12
  - key: modernize-use-default-member-init.UseAssignment
13
    value: '1'
14
  - key: modernize-use-equals-default.IgnoreMacros
15
    value: '0'
16
  - key: modernize-use-auto.MinTypeNameLength
17
    value: '80'

1
---
2
## 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
3
Language: Cpp
4
## 基础风格
5
## BasedOnStyle:  LLVM
6
## 访问说明符(public、private等)的偏移
7
AccessModifierOffset: -4
8
## 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
9
AlignAfterOpenBracket: Align
10
## 对齐数组列
11
AlignArrayOfStructures: None
12
## 对齐连续宏定义
13
AlignConsecutiveMacros: None
14
## 连续赋值时，对齐所有等号
15
AlignConsecutiveAssignments: None
16
## 对齐连续位字段
17
AlignConsecutiveBitFields: None
18
## 连续声明时，对齐所有声明的变量名
19
AlignConsecutiveDeclarations: None
20
## 左对齐逃脱换行(使用反斜杠换行)的反斜杠
21
AlignEscapedNewlines: Left
22
## 水平对齐二元和三元表达式的操作数
23
AlignOperands: Align
24
## 对齐连续的尾随的注释
25
AlignTrailingComments: true
26
## 允许函数声明的所有参数在放在下一行
27
AllowAllParametersOfDeclarationOnNextLine: true
28
## 允许短的枚举放在同一行
29
AllowShortEnumsOnASingleLine: true
30
## 允许短的块放在同一行
31
AllowShortBlocksOnASingleLine: Never
32
## 允许短的case标签放在同一行
33
AllowShortCaseLabelsOnASingleLine: false
34
## 允许短的函数放在同一行
35
AllowShortFunctionsOnASingleLine: All
36
## 允许短的匿名函数放在同一行
37
AllowShortLambdasOnASingleLine: All
38
## 允许短的if语句保持在同一行
39
AllowShortIfStatementsOnASingleLine: Never
40
## 允许短的循环保持在同一行
41
AllowShortLoopsOnASingleLine: false
42
## 总是在返回类型后换行
43
AlwaysBreakAfterReturnType: None
44
## 总是在多行string字面量前换行
45
AlwaysBreakBeforeMultilineStrings: false
46
## 总是在template声明后换行
47
AlwaysBreakTemplateDeclarations: MultiLine
48
AttributeMacros:
49
  - __capability
50
## false表示函数实参要么都在同一行，要么都各自一行
51
BinPackArguments: true
52
## false表示所有形参要么都在同一行，要么都各自一行
53
BinPackParameters: true
54
## 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
55
BraceWrapping:
56
  AfterCaseLabel: false
57
  AfterClass: false
58
  AfterControlStatement: Never
59
  AfterEnum: false
60
  AfterFunction: false
61
  AfterNamespace: false
62
  AfterObjCDeclaration: false
63
  AfterStruct: false
64
  AfterUnion: false
65
  AfterExternBlock: false
66
  BeforeCatch: false
67
  BeforeElse: false
68
  BeforeLambdaBody: false
69
  BeforeWhile: false
70
  IndentBraces: false
71
  SplitEmptyFunction: true
72
  SplitEmptyRecord: true
73
  SplitEmptyNamespace: true
74
## 在二元运算符前换行
75
BreakBeforeBinaryOperators: None
76
## 在concept前换行
77
BreakBeforeConceptDeclarations: true
78
## 在大括号前换行: Attach(始终将大括号附加到周围的上下文)
79
BreakBeforeBraces: Attach
80
## 继承列表样式
81
BreakInheritanceList: AfterComma
82
## 在三元运算符前换行
83
BreakBeforeTernaryOperators: true
84
## 构造函数初始值设定项换行样式
85
BreakConstructorInitializers: BeforeComma
86
## 在java字段的注释后换行
87
BreakAfterJavaFieldAnnotations: false
88
## 每行字符的限制，0表示没有限制
89
ColumnLimit: 96
90
## 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
91
CommentPragmas: '^ IWYU pragma:'
92
## 在新行上声明每个命名空间
93
CompactNamespaces: false
94
## 构造函数的初始化列表的缩进宽度
95
ConstructorInitializerIndentWidth: 4
96
## 延续的行的缩进宽度
97
ContinuationIndentWidth: 4
98
## 去除C++11的列表初始化的大括号{后和}前的空格
99
Cpp11BracedListStyle: true
100
## 继承最常用的换行方式
101
DeriveLineEnding: true
102
## 继承最常用的指针和引用的对齐方式
103
DerivePointerAlignment: false
104
## 关闭格式化
105
DisableFormat: false
106
## 删除访问修饰符后的所有空行
107
EmptyLineAfterAccessModifier: Never
108
## 仅当访问修饰符开始一个新的逻辑块时才添加空行
109
EmptyLineBeforeAccessModifier: LogicalBlock
110
## 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental)
111
ExperimentalAutoDetectBinPacking: false
112
## 自动补充namespace注释
113
FixNamespaceComments: true
114
## 需要被解读为foreach循环而不是函数调用的宏
115
ForEachMacros:
116
  - foreach
117
  - Q_FOREACH
118
  - BOOST_FOREACH
119
IfMacros:
120
  - KJ_IF_MAYBE
121
## 多个#include块合并在一起并排序为一个
122
IncludeBlocks: Merge
123
## 可以定义负数优先级从而保证某些#include永远在最前面
124
IncludeCategories:
125
  - Regex: '^"(llvm|llvm-c|clang|clang-c)/'
126
    Priority: 2
127
    SortPriority: 0
128
    CaseSensitive: false
129
  - Regex: '^(<|"(gtest|gmock|isl|json)/)'
130
    Priority: 3
131
    SortPriority: 0
132
    CaseSensitive: false
133
  - Regex: '.*'
134
    Priority: 1
135
    SortPriority: 0
136
    CaseSensitive: false
137
IncludeIsMainRegex: '(Test)?$'
138
IncludeIsMainSourceRegex: ''
139
## 缩进访问修饰符
140
IndentAccessModifiers: false
141
## 缩进case标签
142
IndentCaseLabels: false
143
## case 标签后面的块使用与 case 标签相同的缩进级别
144
IndentCaseBlocks: false
145
## 缩进goto标签。
146
IndentGotoLabels: false
147
## 缩进预处理器指令
148
IndentPPDirectives: None
149
## 向后兼容缩进外部块
150
IndentExternBlock: AfterExternBlock
151
## 缩进模板中的requires子句
152
IndentRequires: false
153
## 缩进宽度
154
IndentWidth: 4
155
## 函数返回类型换行时，缩进函数声明或函数定义的函数名
156
IndentWrappedFunctionNames: false
157
## 插入尾随逗号
158
InsertTrailingCommas: None
159
## 保留JavaScript字符串引号
160
JavaScriptQuotes: Leave
161
## 包装 JavaScript 导入/导出语句
162
JavaScriptWrapImports: true
163
## 保留在块开始处的空行
164
KeepEmptyLinesAtTheStartOfBlocks: true
165
## 相对于 lambda 签名对齐 lambda 主体
166
LambdaBodyIndentation: Signature
167
## 开始一个块的宏的正则表达式
168
MacroBlockBegin: ''
169
## 结束一个块的宏的正则表达式
170
MacroBlockEnd: ''
171
## 连续空行的最大数量
172
MaxEmptyLinesToKeep: 1
173
## 命名空间的缩进
174
NamespaceIndentation: Inner
175
ObjCBinPackProtocolList: Auto
176
## 使用ObjC块时缩进宽度
177
ObjCBlockIndentWidth: 4
178
ObjCBreakBeforeNestedBlockParam: true
179
## 在ObjC的@property后添加一个空格
180
ObjCSpaceAfterProperty: false
181
## 在ObjC的protocol列表前添加一个空格
182
ObjCSpaceBeforeProtocolList: true
183
PenaltyBreakAssignment: 2
184
PenaltyBreakBeforeFirstCallParameter: 19
185
PenaltyBreakComment: 300
186
PenaltyBreakFirstLessLess: 120
187
PenaltyBreakString: 1000
188
PenaltyBreakTemplateDeclaration: 10
189
PenaltyExcessCharacter: 1000000
190
PenaltyReturnTypeOnItsOwnLine: 60
191
PenaltyIndentedWhitespace: 0
192
## 指针的对齐: Left, Right, Middle
193
PointerAlignment: Left
194
## 缩进预处理器语句的列数
195
PPIndentWidth: -1
196
## 引用的对齐
197
ReferenceAlignment: Pointer
198
## 允许重新排版注释
199
ReflowComments: true
200
## 短命名空间跨越的最大展开行数
201
ShortNamespaceLines: 1
202
## 允许排序#include
203
SortIncludes: false
204
## java静态导入放在非静态导入之前
205
SortJavaStaticImport: Before
206
## 对using声明排序
207
SortUsingDeclarations: true
208
## 在C风格类型转换后添加空格
209
SpaceAfterCStyleCast: false
210
## 在!后添加空格
211
SpaceAfterLogicalNot: false
212
## 在Template关键字后添加空格
213
SpaceAfterTemplateKeyword: true
214
## 在赋值运算符之前添加空格
215
SpaceBeforeAssignmentOperators: true
216
## 不在case冒号之前添加空格
217
SpaceBeforeCaseColon: false
218
## 不在C++11大括号列表之前添加空格
219
SpaceBeforeCpp11BracedList: false
220
## 在构造函数初始化器冒号之前添加空格
221
SpaceBeforeCtorInitializerColon: true
222
## 在继承冒号前添加空格
223
SpaceBeforeInheritanceColon: true
224
## 开圆括号之前添加一个空格: Never, ControlStatements, Always
225
SpaceBeforeParens: ControlStatements
226
## 不要确保指针限定符周围有空格，而是使用 PointerAlignment
227
SpaceAroundPointerQualifiers: Default
228
## 在基于范围的for循环冒号之前添加空格
229
SpaceBeforeRangeBasedForLoopColon: true
230
## {}中间不添加空格
231
SpaceInEmptyBlock: false
232
## 在空的圆括号中添加空格
233
SpaceInEmptyParentheses: false
234
## 在尾随的评论前添加的空格数(只适用于//)
235
SpacesBeforeTrailingComments: 1
236
## 在尖括号的<后和>前添加空格
237
SpacesInAngles: Never
238
## 不在if/for/switch/while条件周围插入空格
239
SpacesInConditionalStatement: false
240
## 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
241
SpacesInContainerLiterals: true
242
## 在C风格类型转换的括号中添加空格
243
SpacesInCStyleCastParentheses: false
244
## 行注释开头允许有多少个空格。要禁用最大值，请将其设置为-1，除此之外，最大值优先于最小值
245
SpacesInLineCommentPrefix:
246
  Minimum: 1
247
  Maximum: -1
248
## 在圆括号的(后和)前添加空格
249
SpacesInParentheses: false
250
## 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
251
SpacesInSquareBrackets: false
252
## 不在[前添加空格
253
SpaceBeforeSquareBrackets: false
254
## 位域:每边都添加空格
255
BitFieldColonSpacing: Both
256
## 标准
257
Standard: Auto
258
## 在语句前面被忽略的宏定义，就好像它们是一个属性一样
259
StatementAttributeLikeMacros:
260
  - Q_EMIT
261
## 应该被解释为完整语句的宏定义
262
StatementMacros:
263
  - Q_UNUSED
264
  - QT_REQUIRE_VERSION
265
## tab宽度
266
TabWidth: 4
267
## 使用\n换行
268
UseCRLF: false
269
## 使用tab字符：ForIndentation——仅将制表符用于缩进
270
UseTab: Never
271
## 对空格敏感的宏定义
272
WhitespaceSensitiveMacros:
273
  - STRINGIZE
274
  - PP_STRINGIZE
275
  - BOOST_PP_STRINGIZE
276
  - NS_SWIFT_NAME
277
  - CF_SWIFT_NAME

1
#include <iostream>
2

3
int main() {
4
    std::cout << "Hello, world!" << std::endl;
5
    return 0;
6
}