EditorConfig 属性用于 XMLDOC：格式化样式

制表符和缩进

缩进样式

属性名称：

indent_style， [resharper_]xmldoc_indent_style

可能的值：

tab: 制表符
space: 空格

示例:

制表符
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

空格
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

缩进大小

属性名称：

indent_size， [resharper_]xmldoc_indent_size

可能的值：

一个整数

示例:

值：0
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

值：1
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

值：2
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

制表符宽度

属性名称：

tab_width， [resharper_]xmldoc_tab_width

可能的值：

一个整数

示例:

值：0
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

值：1
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

值：2
/// <tag1> /// <tag2> /// text /// </tag2> /// </tag1>

制表符用于缩进时如何对齐

属性名称：

[resharper_]xmldoc_alignment_tab_fill_style， [resharper_]alignment_tab_fill_style

可能的值：

use_spaces: 使用空格（在任何制表符大小下看起来都对齐）
use_tabs_only: 仅使用制表符（不准确）
optimal_fill: 混合使用制表符和空格以实现最佳填充

即使结果缩进过大也要对齐

属性名称：

[resharper_]xmldoc_allow_far_alignment， [resharper_]allow_far_alignment

Allow alignment even if construct is located too far to the right, more than 2/3 of `Hard wrap at` limit
   

可能的值：

true｜false

换行

硬换行于

属性名称：

max_line_length， [resharper_]xmldoc_max_line_length

可能的值：

一个整数

将标记和处理指令换行

属性名称：

[resharper_]xmldoc_wrap_tags_and_pi， [resharper_]wrap_tags_and_pi

可能的值：

true｜false

示例:

格式化前	格式化后，true
/// <tag attr1='1234567890' attr2='1234567890'/>	/// <tag attr1='1234567890' /// attr2='1234567890' />

格式化前	格式化后，false
/// <tag attr1='1234567890' attr2='1234567890'/>	/// <tag attr1='1234567890' attr2='1234567890' />

处理指令

在特性中的 '=' 周围空格

属性名称：

[resharper_]xmldoc_spaces_around_eq_in_pi_attribute， [resharper_]spaces_around_eq_in_pi_attribute

可能的值：

true｜false

示例:

true
/// <?xml version = '1.0' encoding = 'utf-8'?>

false
/// <?xml version='1.0' encoding='utf-8'?>

在最后一个特性后空格

属性名称：

[resharper_]xmldoc_space_after_last_pi_attribute， [resharper_]space_after_last_pi_attribute

可能的值：

true｜false

示例:

true
/// <?xml version='1.0' encoding='utf-8' ?>

false
/// <?xml version='1.0' encoding='utf-8'?>

特性格式

属性名称：

[resharper_]xmldoc_pi_attribute_style， [resharper_]pi_attribute_style

可能的值：

on_single_line ：在单行上
first_attribute_on_single_line ：第一个属性在单行上
on_different_lines ：每个属性在单独的行上
do_not_touch ：不做任何更改

示例:

on_single_line
/// <?xml version='1.0' encoding='utf-8'?>

first_attribute_on_single_line
/// <?xml version='1.0' /// encoding='utf-8'?>

on_different_lines
/// <?xml /// version='1.0' /// encoding='utf-8'?>

do_not_touch
/// <?xml version='1.0' encoding='utf-8'?>

特性缩进

属性名称：

[resharper_]xmldoc_pi_attributes_indent， [resharper_]pi_attributes_indent

可能的值：

single_indent ：单缩进
double_indent ：双缩进
align_by_first_attribute ：按第一个属性对齐

示例:

single_indent
/// <?xml version='1.0' /// encoding='utf-8'?>

double_indent
/// <?xml version='1.0' /// encoding='utf-8'?>

align_by_first_attribute
/// <?xml version='1.0' /// encoding='utf-8'?>

处理指令后空行

属性名称：

[resharper_]xmldoc_blank_line_after_pi， [resharper_]blank_line_after_pi

可能的值：

true｜false

示例:

true
/// <?xml version='1.0' encoding='utf-8'?> /// /// <a />

false
/// <?xml version='1.0' encoding='utf-8'?> /// <a />

标签头部内部

在特性中的 '=' 周围空格

属性名称：

[resharper_]xmldoc_spaces_around_eq_in_attribute， [resharper_]spaces_around_eq_in_attribute

可能的值：

true｜false

示例:

true
/// <a x = '1' y = '2' z = '3' />

false
/// <a x='1' y='2' z='3' />

在最后一个特性后空格

属性名称：

[resharper_]xmldoc_space_after_last_attribute， [resharper_]space_after_last_attribute

可能的值：

true｜false

示例:

true
/// <a x='1' y='2' z='3' >text</a>

false
/// <a x='1' y='2' z='3'>text</a>

在 '/>' 前空格

属性名称：

[resharper_]xmldoc_space_before_self_closing， [resharper_]space_before_self_closing

可能的值：

true｜false

示例:

true
/// <a />

false
/// <a/>

特性格式

属性名称：

[resharper_]xmldoc_attribute_style， [resharper_]attribute_style

可能的值：

on_single_line ：在单行上
first_attribute_on_single_line ：第一个属性在单行上
on_different_lines ：每个属性在单独的行上
do_not_touch ：不做任何更改

示例:

on_single_line
/// <a x='1' y='2' z='3' />

first_attribute_on_single_line
/// <a x='1' /// y='2' /// z='3' />

on_different_lines
/// <a /// x='1' /// y='2' /// z='3' />

do_not_touch
/// <a x='1' y='2' z='3' />

特性缩进

属性名称：

[resharper_]xmldoc_attribute_indent， [resharper_]attribute_indent

可能的值：

single_indent ：单缩进
double_indent ：双缩进
align_by_first_attribute ：按第一个属性对齐

示例:

single_indent
/// <a x='1' /// y='2' /// z='3' />

double_indent
/// <a x='1' /// y='2' /// z='3' />

align_by_first_attribute
/// <a x='1' /// y='2' /// z='3' />

标签内容

保留现有换行符

属性名称：

[resharper_]xmldoc_keep_user_linebreaks， [resharper_]keep_user_linebreaks

可能的值：

true｜false

示例:

格式化前	格式化后，true
/// <summary> /// text /// more text /// </summary>	/// <summary> /// text /// more text /// </summary>

格式化前	格式化后，false
/// <summary> /// text /// more text /// </summary>	/// <summary>text more text</summary>

在多行元素中的开始标记后和结束标记前换行

属性名称：

[resharper_]xmldoc_linebreaks_inside_tags_for_multiline_elements， [resharper_]linebreaks_inside_tags_for_multiline_elements

可能的值：

true｜false

示例:

true
/// <tag> /// text text text /// Text text text text text text text text text /// </tag>

false
/// <tag>text text text /// Text text text text text text text text text</tag>

在包含其他元素且无文本的元素的开始标记后和结束标记前换行

属性名称：

[resharper_]xmldoc_linebreaks_inside_tags_for_elements_with_child_elements， [resharper_]linebreaks_inside_tags_for_elements_with_child_elements

可能的值：

true｜false

示例:

true
/// <tag> /// <othertag>text</othertag> /// </tag>

false
/// <tag><othertag>text</othertag></tag>

当元素长于此值时在开始标记后和结束标记前换行

属性名称：

[resharper_]xmldoc_linebreaks_inside_tags_for_elements_longer_than， [resharper_]linebreaks_inside_tags_for_elements_longer_than

Format long tags like this:
<tag>
  content
</tag>
   

可能的值：

一个整数

所有其他情况下在开始标记后和结束标记前空格

属性名称：

[resharper_]xmldoc_spaces_inside_tags， [resharper_]spaces_inside_tags

可能的值：

true｜false

示例:

true
/// <tag> Text text text text text text text text text </tag>

false
/// <tag>Text text text text text text text text text</tag>

在文本内换行

属性名称：

[resharper_]xmldoc_wrap_text， [resharper_]wrap_text

可能的值：

true｜false

示例:

格式化前	格式化后，true
/// <tag> /// Text text text text text text text text text /// </tag>	/// <tag> /// Text text text text text /// text text text text /// </tag>

格式化前	格式化后，false
/// <tag> /// Text text text text text text text text text /// </tag>	/// <tag> /// Text text text text text text text text text /// </tag>

在元素之前和之后换行

属性名称：

[resharper_]xmldoc_wrap_around_elements， [resharper_]wrap_around_elements

可能的值：

true｜false

示例:

格式化前	格式化后，true
/// <tag> /// Text text text text text <tag/> text text text /// </tag>	/// <tag> /// Text text text text text /// <tag /> text text text /// </tag>

格式化前	格式化后，false
/// <tag> /// Text text text text text <tag/> text text text /// </tag>	/// <tag> /// Text text text text text /// <tag /> text text text /// </tag>

在不包含文本的元素内缩进

属性名称：

[resharper_]xmldoc_indent_child_elements， [resharper_]indent_child_elements

可能的值：

DoNotTouch: 不更改缩进
do_not_touch: 不更改缩进
OneIndent: 从父元素缩进一级
one_indent: 从父元素缩进一级
ZeroIndent: 从父元素不缩进
zero_indent: 从父元素不缩进
RemoveIndent: 完全不缩进
remove_indent: 完全不缩进

示例:

DoNotTouch
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

do_not_touch
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

OneIndent
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

one_indent
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

ZeroIndent
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

zero_indent
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

RemoveIndent
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

remove_indent
/// <toplevel> /// <summary> /// <tag /> /// <tag /> /// </summary> /// </toplevel>

在包含文本的元素内缩进

属性名称：

[resharper_]xmldoc_indent_text， [resharper_]indent_text

可能的值：

DoNotTouch: 不更改缩进
do_not_touch: 不更改缩进
OneIndent: 从父元素缩进一级
one_indent: 从父元素缩进一级
ZeroIndent: 从父元素不缩进
zero_indent: 从父元素不缩进
RemoveIndent: 完全不缩进
remove_indent: 完全不缩进

示例:

DoNotTouch
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

do_not_touch
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

OneIndent
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

one_indent
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

ZeroIndent
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

zero_indent
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

RemoveIndent
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

remove_indent
/// <toplevel> /// <summary> /// text1 /// text2 /// </summary> /// </toplevel>

标签周围

标记之间的最大空行数

属性名称：

[resharper_]xmldoc_max_blank_lines_between_tags， [resharper_]max_blank_lines_between_tags

Maximum blank lines between tags

可能的值：

一个整数

将多行元素置于新行中

属性名称：

[resharper_]xmldoc_linebreak_before_multiline_elements， [resharper_]linebreak_before_multiline_elements

可能的值：

true｜false

示例:

true
/// <exception> /// Text /// <tag> /// text /// </tag> /// text /// </exception>

false
/// <exception> /// Text <tag> /// text /// </tag> text /// </exception>

将单行元素置于新行中

属性名称：

[resharper_]xmldoc_linebreak_before_singleline_elements， [resharper_]linebreak_before_singleline_elements

可能的值：

true｜false

示例:

true
/// <exception> /// See /// <see cref="something" /> /// for more info /// </exception>

false
/// <exception> /// See <see cref="something" /> for more info /// </exception>

始终将后续元素置于新行中

属性名称：

[resharper_]xmldoc_linebreak_before_elements， [resharper_]linebreak_before_elements

最后修改日期： 2025年 9月 27日