XMLDOC の EditorConfig プロパティ: スタイルのフォーマット
タブとインデント
インデントスタイル
プロパティ名:
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
使用可能な値:
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: 1 行の最初の属性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: 1 行の最初の属性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
使用可能な値:
整数
開始タグの後のスペースと終了タグの前のスペース
プロパティ名:
[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
使用可能な値:
整数
複数行の要素を新しい行に配置する
プロパティ名:
[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