C# formatting options

The formatting options in this article apply only to C# code. These are options for code-style rule IDE0055.

New-line options

The new-line options concern the use of new lines to format code.

• csharp_new_line_before_open_brace
• csharp_new_line_before_else
• csharp_new_line_before_catch
• csharp_new_line_before_finally
• csharp_new_line_before_members_in_object_initializers
• csharp_new_line_before_members_in_anonymous_types
• csharp_new_line_between_query_expression_clauses

Example .editorconfig file:

# CSharp formatting rules: [*.cs] csharp_new_line_before_open_brace = methods, properties, control_blocks, types csharp_new_line_before_else = true csharp_new_line_before_catch = true csharp_new_line_before_finally = true csharp_new_line_before_members_in_object_initializers = true csharp_new_line_before_members_in_anonymous_types = true csharp_new_line_between_query_expression_clauses = true 

csharp_new_line_before_open_brace

This option concerns whether an open brace { should be placed on the same line as the preceding code, or on a new line. For this rule, you specify all, none, or one or more code elements such as methods or properties, to define when this rule should be applied. To specify multiple code elements, separate them with a comma (,).

Code examples:

// csharp_new_line_before_open_brace = all void MyMethod() { if (...) { ... } } // csharp_new_line_before_open_brace = none void MyMethod() { if (...) { ... } } 

csharp_new_line_before_else

Code examples:

// csharp_new_line_before_else = true if (...) { ... } else { ... } // csharp_new_line_before_else = false if (...) { ... } else { ... } 

csharp_new_line_before_catch

Code examples:

// csharp_new_line_before_catch = true try { ... } catch (Exception e) { ... } // csharp_new_line_before_catch = false try { ... } catch (Exception e) { ... } 

csharp_new_line_before_finally

Code examples:

// csharp_new_line_before_finally = true try { ... } catch (Exception e) { ... } finally { ... } // csharp_new_line_before_finally = false try { ... } catch (Exception e) { ... } finally { ... } 

csharp_new_line_before_members_in_object_initializers

Code examples:

// csharp_new_line_before_members_in_object_initializers = true var z = new B() { A = 3, B = 4 } // csharp_new_line_before_members_in_object_initializers = false var z = new B() { A = 3, B = 4 } 

csharp_new_line_before_members_in_anonymous_types

Code examples:

// csharp_new_line_before_members_in_anonymous_types = true var z = new { A = 3, B = 4 } // csharp_new_line_before_members_in_anonymous_types = false var z = new { A = 3, B = 4 } 

csharp_new_line_between_query_expression_clauses

Code examples:

// csharp_new_line_between_query_expression_clauses = true var q = from a in e from b in e select a * b; // csharp_new_line_between_query_expression_clauses = false var q = from a in e from b in e select a * b; 

Indentation options

The indentation options concern the use of indentation to format code.

• csharp_indent_case_contents
• csharp_indent_switch_labels
• csharp_indent_labels
• csharp_indent_block_contents
• csharp_indent_braces
• csharp_indent_case_contents_when_block

Example .editorconfig file:

# CSharp formatting rules: [*.cs] csharp_indent_case_contents = true csharp_indent_switch_labels = true csharp_indent_labels = flush_left csharp_indent_block_contents = true csharp_indent_braces = false csharp_indent_case_contents_when_block = true 

csharp_indent_case_contents

Code examples:

// csharp_indent_case_contents = true switch(c) { case Color.Red: Console.WriteLine("The color is red"); break; case Color.Blue: Console.WriteLine("The color is blue"); break; default: Console.WriteLine("The color is unknown."); break; } // csharp_indent_case_contents = false switch(c) { case Color.Red: Console.WriteLine("The color is red"); break; case Color.Blue: Console.WriteLine("The color is blue"); break; default: Console.WriteLine("The color is unknown."); break; } 

csharp_indent_switch_labels

Code examples:

// csharp_indent_switch_labels = true switch(c) { case Color.Red: Console.WriteLine("The color is red"); break; case Color.Blue: Console.WriteLine("The color is blue"); break; default: Console.WriteLine("The color is unknown."); break; } // csharp_indent_switch_labels = false switch(c) { case Color.Red: Console.WriteLine("The color is red"); break; case Color.Blue: Console.WriteLine("The color is blue"); break; default: Console.WriteLine("The color is unknown."); break; } 

csharp_indent_labels

Code examples:

// csharp_indent_labels= flush_left class C { private string MyMethod(...) { if (...) { goto error; } error: throw new Exception(...); } } // csharp_indent_labels = one_less_than_current class C { private string MyMethod(...) { if (...) { goto error; } error: throw new Exception(...); } } // csharp_indent_labels= no_change class C { private string MyMethod(...) { if (...) { goto error; } error: throw new Exception(...); } } 

csharp_indent_block_contents

Code examples:

// csharp_indent_block_contents = true static void Hello() { Console.WriteLine("Hello"); } // csharp_indent_block_contents = false static void Hello() { Console.WriteLine("Hello"); } 

csharp_indent_braces

Code examples:

// csharp_indent_braces = true static void Hello() { Console.WriteLine("Hello"); } // csharp_indent_braces = false static void Hello() { Console.WriteLine("Hello"); } 

csharp_indent_case_contents_when_block

Code examples:

// csharp_indent_case_contents_when_block = true case 0: { Console.WriteLine("Hello"); break; } // csharp_indent_case_contents_when_block = false case 0: { Console.WriteLine("Hello"); break; } 

Spacing options

The spacing options concern the use of space characters to format code.

• csharp_space_after_cast
• csharp_space_after_keywords_in_control_flow_statements
• csharp_space_between_parentheses
• csharp_space_before_colon_in_inheritance_clause
• csharp_space_after_colon_in_inheritance_clause
• csharp_space_around_binary_operators
• csharp_space_between_method_declaration_parameter_list_parentheses
• csharp_space_between_method_declaration_empty_parameter_list_parentheses
• csharp_space_between_method_declaration_name_and_open_parenthesis
• csharp_space_between_method_call_parameter_list_parentheses
• csharp_space_between_method_call_empty_parameter_list_parentheses
• csharp_space_between_method_call_name_and_opening_parenthesis
• csharp_space_after_comma
• csharp_space_before_comma
• csharp_space_after_dot
• csharp_space_before_dot
• csharp_space_after_semicolon_in_for_statement
• csharp_space_before_semicolon_in_for_statement
• csharp_space_around_declaration_statements
• csharp_space_before_open_square_brackets
• csharp_space_between_empty_square_brackets
• csharp_space_between_square_brackets

Example .editorconfig file:

# CSharp formatting rules: [*.cs] csharp_space_after_cast = true csharp_space_after_keywords_in_control_flow_statements = true csharp_space_between_parentheses = control_flow_statements, type_casts csharp_space_before_colon_in_inheritance_clause = true csharp_space_after_colon_in_inheritance_clause = true csharp_space_around_binary_operators = before_and_after csharp_space_between_method_declaration_parameter_list_parentheses = true csharp_space_between_method_declaration_empty_parameter_list_parentheses = false csharp_space_between_method_declaration_name_and_open_parenthesis = false csharp_space_between_method_call_parameter_list_parentheses = true csharp_space_between_method_call_empty_parameter_list_parentheses = false csharp_space_between_method_call_name_and_opening_parenthesis = false csharp_space_after_comma = true csharp_space_before_comma = false csharp_space_after_dot = false csharp_space_before_dot = false csharp_space_after_semicolon_in_for_statement = true csharp_space_before_semicolon_in_for_statement = false csharp_space_around_declaration_statements = false csharp_space_before_open_square_brackets = false csharp_space_between_empty_square_brackets = false csharp_space_between_square_brackets = false 

csharp_space_after_cast

Code examples:

// csharp_space_after_cast = true int y = (int) x; // csharp_space_after_cast = false int y = (int)x; 

csharp_space_after_keywords_in_control_flow_statements

Code examples:

// csharp_space_after_keywords_in_control_flow_statements = true for (int i;i<x;i++) { ... } // csharp_space_after_keywords_in_control_flow_statements = false for(int i;i<x;i++) { ... } 

csharp_space_between_parentheses

†If you omit this rule or use any value other than control_flow_statements, expressions, or type_casts, spaces between parentheses of control flow statements, expressions, and type casts are removed.

Code examples:

// csharp_space_between_parentheses = control_flow_statements for ( int i = 0; i < 10; i++ ) { } // csharp_space_between_parentheses = expressions var z = ( x * y ) - ( ( y - x ) * 3 ); // csharp_space_between_parentheses = type_casts int y = ( int )x; // csharp_space_between_parentheses = false for (int i = 0; i < 10; i++) { } var z = (x * y) - ((y - x) * 3); int y = (int)x; 

csharp_space_before_colon_in_inheritance_clause

Code examples:

// csharp_space_before_colon_in_inheritance_clause = true interface I { } class C : I { } // csharp_space_before_colon_in_inheritance_clause = false interface I { } class C: I { } 

csharp_space_after_colon_in_inheritance_clause

Code examples:

// csharp_space_after_colon_in_inheritance_clause = true interface I { } class C : I { } // csharp_space_after_colon_in_inheritance_clause = false interface I { } class C :I { } 

csharp_space_around_binary_operators

Code examples:

// csharp_space_around_binary_operators = before_and_after return x * (x - y); // csharp_space_around_binary_operators = none return x*(x-y); // csharp_space_around_binary_operators = ignore return x * (x-y); 

csharp_space_between_method_declaration_parameter_list_parentheses

Code examples:

// csharp_space_between_method_declaration_parameter_list_parentheses = true void Bark( int x ) { ... } // csharp_space_between_method_declaration_parameter_list_parentheses = false void Bark(int x) { ... } 

csharp_space_between_method_declaration_empty_parameter_list_parentheses

Code examples:

// csharp_space_between_method_declaration_empty_parameter_list_parentheses = true void Goo( ) { Goo(1); } void Goo(int x) { Goo(); } // csharp_space_between_method_declaration_empty_parameter_list_parentheses = false void Goo() { Goo(1); } void Goo(int x) { Goo(); } 

csharp_space_between_method_declaration_name_and_open_parenthesis

Code examples:

// csharp_space_between_method_declaration_name_and_open_parenthesis = true void M () { } // csharp_space_between_method_declaration_name_and_open_parenthesis = false void M() { } 

csharp_space_between_method_call_parameter_list_parentheses

Code examples:

// csharp_space_between_method_call_parameter_list_parentheses = true MyMethod( argument ); // csharp_space_between_method_call_parameter_list_parentheses = false MyMethod(argument); 

csharp_space_between_method_call_empty_parameter_list_parentheses

Code examples:

// csharp_space_between_method_call_empty_parameter_list_parentheses = true void Goo() { Goo(1); } void Goo(int x) { Goo( ); } // csharp_space_between_method_call_empty_parameter_list_parentheses = false void Goo() { Goo(1); } void Goo(int x) { Goo(); } 

csharp_space_between_method_call_name_and_opening_parenthesis

Code examples:

// csharp_space_between_method_call_name_and_opening_parenthesis = true void Goo() { Goo (1); } void Goo(int x) { Goo (); } // csharp_space_between_method_call_name_and_opening_parenthesis = false void Goo() { Goo(1); } void Goo(int x) { Goo(); } 

csharp_space_after_comma

Code examples:

// csharp_space_after_comma = true int[] x = new int[] { 1, 2, 3, 4, 5 }; // csharp_space_after_comma = false int[] x = new int[] { 1,2,3,4,5 }; 

csharp_space_before_comma

Code examples:

// csharp_space_before_comma = true int[] x = new int[] { 1 , 2 , 3 , 4 , 5 }; // csharp_space_before_comma = false int[] x = new int[] { 1, 2, 3, 4, 5 }; 

csharp_space_after_dot

Code examples:

// csharp_space_after_dot = true this. Goo(); // csharp_space_after_dot = false this.Goo(); 

csharp_space_before_dot

Code examples:

// csharp_space_before_dot = true this .Goo(); // csharp_space_before_dot = false this.Goo(); 

csharp_space_after_semicolon_in_for_statement

Code examples:

// csharp_space_after_semicolon_in_for_statement = true for (int i = 0; i < x.Length; i++) // csharp_space_after_semicolon_in_for_statement = false for (int i = 0;i < x.Length;i++) 

csharp_space_before_semicolon_in_for_statement

Code examples:

// csharp_space_before_semicolon_in_for_statement = true for (int i = 0 ; i < x.Length ; i++) // csharp_space_before_semicolon_in_for_statement = false for (int i = 0; i < x.Length; i++) 

csharp_space_around_declaration_statements

Code examples:

// csharp_space_around_declaration_statements = ignore int x = 0 ; // csharp_space_around_declaration_statements = false int x = 0; 

csharp_space_before_open_square_brackets

Code examples:

// csharp_space_before_open_square_brackets = true int [] numbers = new int [] { 1, 2, 3, 4, 5 }; // csharp_space_before_open_square_brackets = false int[] numbers = new int[] { 1, 2, 3, 4, 5 }; 

csharp_space_between_empty_square_brackets

Code examples:

// csharp_space_between_empty_square_brackets = true int[ ] numbers = new int[ ] { 1, 2, 3, 4, 5 }; // csharp_space_between_empty_square_brackets = false int[] numbers = new int[] { 1, 2, 3, 4, 5 }; 

csharp_space_between_square_brackets

Code examples:

// csharp_space_between_square_brackets = true int index = numbers[ 0 ]; // csharp_space_between_square_brackets = false int index = numbers[0]; 

Wrap options

The wrap formatting options concern the use of single lines versus separate lines for statements and code blocks.

• csharp_preserve_single_line_statements
• csharp_preserve_single_line_blocks

Example .editorconfig file:

# CSharp formatting rules: [*.cs] csharp_preserve_single_line_statements = true csharp_preserve_single_line_blocks = true 

csharp_preserve_single_line_statements

Code examples:

//csharp_preserve_single_line_statements = true int i = 0; string name = "John"; //csharp_preserve_single_line_statements = false int i = 0; string name = "John"; 

csharp_preserve_single_line_blocks

Code examples:

//csharp_preserve_single_line_blocks = true public int Foo { get; set; } //csharp_preserve_single_line_blocks = false public int MyProperty { get; set; } 

See also

• Formatting rule (IDE0055)