前提条件

安装扩展C/C++，扩展程序将自动安装clang-format。clang-format默认安装路径为c:\Users\wqr57\.vscode\extensions\ms-vscode.cpptools-0.18.1/bin/../LLVM/bin/clang-format.exe

 

首选项设置

打开首选项设置（ctrl + ,），搜索format .

可勾选format on save 自动保存。

C_Cpp: Clang_format_style 决定格式化形式，若为file，则调用在workspace中的.clang-format

C_Cpp: Clang_format_fallback Style ，若上图变量为file，但无.clang-format文件则按照此处规则。

.clang-format

powershell中输入

clang-format -style=llvm -dump-config > .clang-format

产生模板

决定自定义格式化

1. ---

2. # 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto

3. Language: Cpp

4. # BasedOnStyle: LLVM

5. # 访问说明符(public、private等)的偏移

6. AccessModifierOffset: -2

7. # 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)

8. AlignAfterOpenBracket: Align

9. # 连续赋值时，对齐所有等号

10. AlignConsecutiveAssignments: true

11. # 连续声明时，对齐所有声明的变量名

12. AlignConsecutiveDeclarations: true

13.  

14. AlignEscapedNewlines: Right

15.  

16. # 左对齐逃脱换行(使用反斜杠换行)的反斜杠

17. #AlignEscapedNewlinesLeft: true

18. # 水平对齐二元和三元表达式的操作数

19. AlignOperands: true

20. # 对齐连续的尾随的注释

21. AlignTrailingComments: true

22.  

23. # 允许函数声明的所有参数在放在下一行

24. AllowAllParametersOfDeclarationOnNextLine: false

25. # 允许短的块放在同一行

26. AllowShortBlocksOnASingleLine: true

27. # 允许短的case标签放在同一行

28. AllowShortCaseLabelsOnASingleLine: true

29. # 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All

30. AllowShortFunctionsOnASingleLine: Empty

31. # 允许短的if语句保持在同一行

32. AllowShortIfStatementsOnASingleLine: false

33. # 允许短的循环保持在同一行

34. AllowShortLoopsOnASingleLine: false

35.  

36. # 总是在定义返回类型后换行(deprecated)

37. AlwaysBreakAfterDefinitionReturnType: None

38. # 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数),

39. # AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)

40. AlwaysBreakAfterReturnType: None

41. # 总是在多行string字面量前换行

42. AlwaysBreakBeforeMultilineStrings: false

43. # 总是在template声明后换行

44. AlwaysBreakTemplateDeclarations: false

45. # false表示函数实参要么都在同一行，要么都各自一行

46. BinPackArguments: true

47. # false表示所有形参要么都在同一行，要么都各自一行

48. BinPackParameters: false

49. # 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效

50. BraceWrapping:

51. # class定义后面

52. AfterClass: false

53. # 控制语句后面

54. AfterControlStatement: false

55. # enum定义后面

56. AfterEnum: false

57. # 函数定义后面

58. AfterFunction: true

59. # 命名空间定义后面

60. AfterNamespace: false

61. # ObjC定义后面

62. AfterObjCDeclaration: false

63. # struct定义后面

64. AfterStruct: true

65. # union定义后面

66. AfterUnion: true

67.  

68. AfterExternBlock: false

69. # catch之前

70. BeforeCatch: true

71. # else之前

72. BeforeElse: true

73. # 缩进大括号

74. IndentBraces: false

75. SplitEmptyFunction: true

76. SplitEmptyRecord: true

77. SplitEmptyNamespace: true

78.  

79. # 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)

80. BreakBeforeBinaryOperators: None

81. # 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似),

82. # Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似),

83. # Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom

84. # 注：这里认为语句块也属于函数

85. BreakBeforeBraces: Custom

86. # 在三元运算符前换行

87. BreakBeforeTernaryOperators: false

88.  

89. # 在构造函数的初始化列表的逗号前换行

90. BreakConstructorInitializersBeforeComma: false

91. BreakConstructorInitializers: BeforeColon

92. # 每行字符的限制，0表示没有限制

93. ColumnLimit: 80

94. # 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变

95. CommentPragmas: '^ IWYU pragma:'

96. CompactNamespaces: false

97. # 构造函数的初始化列表要么都在同一行，要么都各自一行

98. ConstructorInitializerAllOnOneLineOrOnePerLine: false

99. # 构造函数的初始化列表的缩进宽度

100. ConstructorInitializerIndentWidth: 4

101. # 延续的行的缩进宽度

102. ContinuationIndentWidth: 4

103. # 去除C++11的列表初始化的大括号{后和}前的空格

104. Cpp11BracedListStyle: true

105. # 继承最常用的指针和引用的对齐方式

106. DerivePointerAlignment: false

107. # 关闭格式化

108. DisableFormat: false

109. # 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental)

110. ExperimentalAutoDetectBinPacking: false

111. # 需要被解读为foreach循环而不是函数调用的宏

112. ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]

113. # 对#include进行排序，匹配了某正则表达式的#include拥有对应的优先级，匹配不到的则默认优先级为INT_MAX(优先级越小排序越靠前)，

114. # 可以定义负数优先级从而保证某些#include永远在最前面

115. IncludeCategories:

116. - Regex: '^"(llvm|llvm-c|clang|clang-c)/'

117. Priority: 2

118. - Regex: '^(<|"(gtest|isl|json)/)'

119. Priority: 3

120. - Regex: '.*'

121. Priority: 1

122. # 缩进case标签

123. IndentCaseLabels: true

124.  

125. IndentPPDirectives: AfterHash

126. # 缩进宽度

127. IndentWidth: 4

128. # 函数返回类型换行时，缩进函数声明或函数定义的函数名

129. IndentWrappedFunctionNames: false

130. # 保留在块开始处的空行

131. KeepEmptyLinesAtTheStartOfBlocks: false

132. # 开始一个块的宏的正则表达式

133. MacroBlockBegin: ''

134. # 结束一个块的宏的正则表达式

135. MacroBlockEnd: ''

136. # 连续空行的最大数量

137. MaxEmptyLinesToKeep: 1

138. # 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All

139. NamespaceIndentation: Inner

140. # 使用ObjC块时缩进宽度

141. ObjCBlockIndentWidth: 4

142. # 在ObjC的@property后添加一个空格

143. ObjCSpaceAfterProperty: false

144. # 在ObjC的protocol列表前添加一个空格

145. ObjCSpaceBeforeProtocolList: true

146.  
147.  

148. # 在call(后对函数调用换行的penalty

149. PenaltyBreakBeforeFirstCallParameter: 19

150. # 在一个注释中引入换行的penalty

151. PenaltyBreakComment: 300

152. # 第一次在<<前换行的penalty

153. PenaltyBreakFirstLessLess: 120

154. # 在一个字符串字面量中引入换行的penalty

155. PenaltyBreakString: 1000

156. # 对于每个在行字符数限制之外的字符的penalty

157. PenaltyExcessCharacter: 1000000

158. # 将函数的返回类型放到它自己的行的penalty

159. PenaltyReturnTypeOnItsOwnLine: 60

160.  

161. # 指针和引用的对齐: Left, Right, Middle

162. PointerAlignment: Left

163. # 允许重新排版注释

164. ReflowComments: true

165. # 允许排序#include

166. SortIncludes: true

167.  

168. # 在C风格类型转换后添加空格

169. SpaceAfterCStyleCast: false

170.  

171. SpaceAfterTemplateKeyword: true

172.  

173. # 在赋值运算符之前添加空格

174. SpaceBeforeAssignmentOperators: true

175. # 开圆括号之前添加一个空格: Never, ControlStatements, Always

176. SpaceBeforeParens: ControlStatements

177. # 在空的圆括号中添加空格

178. SpaceInEmptyParentheses: false

179. # 在尾随的评论前添加的空格数(只适用于//)

180. SpacesBeforeTrailingComments: 2

181. # 在尖括号的<后和>前添加空格

182. SpacesInAngles: false

183. # 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格

184. SpacesInContainerLiterals: false

185. # 在C风格类型转换的括号中添加空格

186. SpacesInCStyleCastParentheses: false

187. # 在圆括号的(后和)前添加空格

188. SpacesInParentheses: false

189. # 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响

190. SpacesInSquareBrackets: false

191. # 标准: Cpp03, Cpp11, Auto

192. Standard: Cpp11

193. # tab宽度

194. TabWidth: 4

195. # 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always

196. UseTab: Never

快捷键

shift+alt+f 文档格式化

ctrl+k ctrl+f 选择快注释

参考链接

Clang-Format格式化选项介绍

C/C++ for Visual Studio Code

ClangFormat