【C++】Visual Studio EditorConfig 格式设置

【C++】Visual Studio EditorConfig 格式设置

I - EditorConfig

Visual Studio 自带支持 .editorconfig 文件，使用时，需要将 .editorconfig 文件放在工程的根目录。

关于 .editorconfig 文件，作用类似于 .clang-format，用于多人开发时多编辑器的配置，为了格式统一等等。

https://editorconfig.org

这个是 EditorConfig 的官方网站，网站中说明了哪些编辑器或者 IDE(集成开发环境) 内置支持此文件，哪些编辑器需要安装插件支持，以及对应编辑器插件的下载链接。

1.1 - 通用设置

禁用设置属性需要使用 unset，举例：

indent_size = unset

表示移除 indent_size 的效果，取消 indent_size 的属性，使用编辑器的默认值

indent_style

缩进样式，可用的值为

• tab
• space

设置缩进使用制表符或空格
此属性值不区分大小写

indent_size

缩进大小，可设置的值为一个正整数或 tab，如果设置为 tab ，也就是与制表符长度相同，则 indent_size 会等于 tab_width，如果未指定 tab_width 则使用编辑器的制表符大小设置

此属性值不区分大小写

tab_width

单个制表符的大小，可以设置为一个正整数，默认值 在 indent_size 设置为数字时与此属性相同

end_of_line

行尾格式可以为三种

• lf
• crlf
• cr

lf 为 Line Feed 即 \n
cr 为 Carrier Return 即 \r
crlf 则为 \r\n

此属性值不区分大小写，如果需要跟随系统默认，则最好不设置此属性

charset

文件的编码字符集
可设置为

• latin1
• utf-8
• utf-16be
• utf-16le
• utf-8-bom

不区分大小写
BOM 为 byte-order mark 字节序标记

trim_trailing_whitespace

指定是否移除行尾空白符

• true 移除所有换行符之前的空白符
• false 保证编辑器保留空白符

不区分大小写

insert_final_newline

指定是否在文件末尾添加空白行，可设置为

• true
• false

II - Visual Studio 特定键值

Visual Studio 中C++ 格式设置 EditorConfig 属性以 cpp_ 为前缀。

示例

# 指定生效的文件
[*.{c++,cc,cpp,cxx,h,h++,hh,hpp,hxx,inl,ipp,tlh,tli}]cpp_indent_case_contents_when_block = true
cpp_new_line_before_open_brace_namespace = same_line

以下为 Visual Studio 和 VS Code 支持的所有 EditorConfig C++ 格式设置。

缩进设置

cpp_indent_braces

缩进大括号
可用值：true、false

cpp_indent_multi_line_relative_to

相对该对象缩进各行
可用值：

• outermost_parenthesis - 键入新行时，它会相对最外侧的左括号缩进。
• innermost_parenthesis - 键入新行时，它会相对最内侧的左括号缩进。
• statement_begin - 键入新行时，它会相对当前语句的开头缩进。

cpp_indent_within_parentheses

在圆括号内部输入新行时进行对齐
可用值：

• align_to_parenthesis - 将内容与左圆括号对齐。
• indent - 缩进新行。

cpp_indent_preserve_within_parentheses

可用值：true、false
在现有代码中，不要使用圆括号中的新行的对齐设置

cpp_indent_case_contents

缩进 case 内容
可用值：true、false
缩进 case 标签

cpp_indent_case_labels

缩进 case 标签
可用值：true、false

cpp_indent_case_contents_when_block

缩进 case 语句后面的大括号
可用值：true、false

cpp_indent_lambda_braces_when_parameter

缩进用作参数的 lambda 的大括号，可用值：true、false

cpp_indent_goto_labels

goto 标签的位置，可用值：

• one_left - 向左缩进一次
• leftmost_column - 移到最左侧的列
• none - 保留缩进

cpp_indent_preprocessor

预处理器指令位置，可用值：

• one_left - 向左缩进一次
• leftmost_column - 移到最左侧的列
• none - 保留缩进

cpp_indent_access_specifiers

缩进访问说明符 ：true、false

cpp_indent_namespace_contents

缩进命名空间内容 ：true、false

cpp_indent_preserve_comments

保留注释的缩进：true、false

换行符设置

cpp_new_line_before_open_brace_namespace

命名空间的左大括号的位置：

• new_line - 移动到新行
• same_line - 保持在同一行上，但在前面添加一个空格
• ignore - 不要自动重新定位

cpp_new_line_before_open_brace_type

类型的左大括号的位置：

• new_line - 移动到新行
• same_line - 保持在同一行上，但在前面添加一个空格
• ignore - 不要自动重新定位

cpp_new_line_before_open_brace_function

函数的左大括号的位置：

• new_line - 移动到新行
• same_line - 保持在同一行上，但在前面添加一个空格
• ignore - 不要自动重新定位

cpp_new_line_before_open_brace_block

控制块的左大括号的位置：

• new_line - 移动到新行
• same_line - 保持在同一行上，但在前面添加一个空格
• ignore - 不要自动重新定位

cpp_new_line_before_open_brace_lambda

lambda 的左大括号的位置：

• new_line - 移动到新行
• same_line - 保持在同一行上，但在前面添加一个空格
• ignore - 不要自动重新定位

cpp_new_line_scope_braces_on_separate_lines

将范围大括号放到单独的行上：true、false

cpp_new_line_close_brace_same_line_empty_type

对于空类型，将右大括号移动到左大括号所在的同一行：true、false

cpp_new_line_close_brace_same_line_empty_function

对于空的函数体，将右大括号移动到左大括号所在的同一行：true、false

cpp_new_line_before_catch

将 catch 和相似的关键字放在新行上：true、false

cpp_new_line_before_else

将 else 放在新行上：true、false

cpp_new_line_before_while_in_do_while

将 do-while 循环中的 while 放在新行上：true、false

间距设置

cpp_space_before_function_open_parenthesis

在函数名称与参数列表的左括号之间插入空格：

• insert - 插入空格
• remove - 移除空格
• ignore - 请勿更改空格

cpp_space_within_parameter_list_parentheses

在参数列表的圆括号中插入空格：true、false

cpp_space_between_empty_parameter_list_parentheses

当参数列表为空时在圆括号之间插入空格：true、false

cpp_space_after_keywords_in_control_flow_statements

在关键字与控制流语句中的左圆括号之间插入空格：true、false

cpp_space_within_control_flow_statement_parentheses

在控制语句的圆括号中插入空格：true、false

cpp_space_before_lambda_open_parenthesis

在 lambda 参数列表的左圆括号前面插入空格：true、false

cpp_space_within_cast_parentheses

在 C 样式强制转换的圆括号中插入空格：true、false

cpp_space_after_cast_close_parenthesis

在 C 样式强制转换的右圆括号后面插入空格：true、false

cpp_space_within_expression_parentheses

在带圆括号的表达式的圆括号中插入空格：true、false

cpp_space_before_block_open_brace

在块的左大括号前插入空格：true、false

cpp_space_between_empty_braces

在空大括号之间插入空格：true、false

cpp_space_before_initializer_list_open_brace

在统一初始化和初始值设定项列表的左大括号前插入空格：true、false

cpp_space_within_initializer_list_braces

在统一初始化和初始值设定项列表中插入空格：true、false

cpp_space_preserve_in_initializer_list

保留统一初始化和初始值设定项列表内的空格：true、false

cpp_space_before_open_square_bracket

在左方括号前插入空格：true、false

cpp_space_within_square_brackets

在方括号中插入空格：true、false

cpp_space_before_empty_square_brackets

在空方括号前插入空格：true、false

cpp_space_between_empty_square_brackets

在空方括号之间插入空格：true、false

cpp_space_group_square_brackets

将多维数组的方括号组合在一起：true、false

cpp_space_within_lambda_brackets

在 lambda 的方括号中插入空格：true、false

cpp_space_between_empty_lambda_brackets

lambda 空的方括号中的空格：true、false

cpp_space_before_comma

在逗号前插入空格：true、false

cpp_space_after_comma

在逗号后面插入空格：true、false

cpp_space_remove_around_member_operators

移除成员运算符前后的空格：true、false

cpp_space_before_inheritance_colon

在类型声明中的基类的冒号前插入空格：true、false

cpp_space_before_constructor_colon

在构造函数中的冒号前插入空格：true、false

cpp_space_remove_before_semicolon

移除分号前的空格：true、false

cpp_space_after_semicolon

在分号后面插入空格：true、false

cpp_space_remove_around_unary_operator

移除一元运算符和其操作数之间的空格 ：true、false

cpp_space_around_binary_operator

二元运算符的间距：

• insert - 在二元运算符的前后插入空格。
• remove - 移除二元运算符周围的空格。
• ignore - 不要更改二元运算符周围的空格。

cpp_space_around_assignment_operator

赋值运算符的间距：

• insert - 在赋值运算符周围插入空格。
• remove - 移除赋值运算符周围的空格。
• ignore - 不要更改赋值运算符周围的空格。

cpp_space_pointer_reference_alignment

指针/引用对齐方式：

• left - 左对齐。
• center - 居中对齐。
• right - 右对齐。
• ignore - 保持不变。

cpp_space_around_ternary_operator

条件运算符的间距：

• insert - 在条件运算符周围插入空格。
• remove - 移除条件运算符周围的空格。
• ignore - 不要更改条件运算符周围的空格。

换行选项

cpp_wrap_preserve_blocks

块的换行选项：

• one_liners - 不要对单行代码块换行。
• all_one_line_scopes - 不要对左大括号和右大括号位于下一行上的代码块进行换行。
• never - 始终为块应用新行设置。

参考链接

• EditorConfig
  https://spec.editorconfig.org

• Microsoft
  https://learn.microsoft.com/en-us/visualstudio/ide/cpp-editorconfig-properties?view=vs-2019

• Github
  https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties