Regras de formatação

As regras de formatação afetam como recuo, espaços e novas linhas são alinhados em torno de constructos de linguagem de programação .NET. As regras se enquadram nas seguintes categorias:

  • Regras de formatação do .NET:regras que se aplicam a C# e Visual Basic. Os nomes de opção EditorConfig para essas regras começam com dotnet_ prefixo.
  • Regras de formatação em C#:regras específicas somente para a linguagem C#. Os nomes de opção EditorConfig para essas regras começam com csharp_ prefixo.

ID da regra: "IDE0055" (Corrigir formatação)

Todas as opções de formatação têm a ID da regra IDE0055 e o título Fix formatting . Definir a severidade de uma violação de formatação em um arquivo EditorConfig usando a linha de configuração a seguir.

dotnet_diagnostic.IDE0055.severity = <severity value>

O valor de severidade deve warning ser ou ser imposto no error build. Para todos os valores de severidade possíveis, consulte nível de severidade.

Formato de opção

As opções para regras de formatação podem ser especificadas em um arquivo EditorConfig com o seguinte formato:

rule_name = value

Para muitas regras, você especifica true (preferir esse estilo) ou false (não preferir esse estilo) para value. Para outras regras, você especifica um valor como flush_left ou before_and_after para descrever quando e onde aplicar a regra. Você não especifica uma gravidade.

Regras de formatação do .NET

As regras de formatação nesta seção se aplicam a C# e Visual Basic.

Organizar usando diretivas

Essas regras de formatação referem-se à classificação e à exibição de diretivas using e instruções Imports.

Exemplo de arquivo .editorconfig:

# .NET formatting rules
[*.{cs,vb}]
dotnet_sort_system_directives_first = true
dotnet_separate_import_directive_groups = true

dotnet_sort_system_directives_first

Propriedade Valor
Nome da opção dotnet_sort_system_directives_first
Idiomas aplicáveis C# e Visual Basic
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – Classificar System.* using diretivas em ordem alfabética e coloque-as antes de outras diretivas de uso.

false - Não coloque System.* using diretivas antes de using outras diretivas.

Exemplos de código:

// dotnet_sort_system_directives_first = true
using System.Collections.Generic;
using System.Threading.Tasks;
using Octokit;

// dotnet_sort_system_directives_first = false
using System.Collections.Generic;
using Octokit;
using System.Threading.Tasks;

dotnet_separate_import_directive_groups

Propriedade Valor
Nome da opção dotnet_separate_import_directive_groups
Idiomas aplicáveis C# e Visual Basic
Versão introduzida Visual Studio 2017 versão 15.5
Valores de opção true – coloque uma linha em branco entre os grupos de diretivas using.

false – não coloque uma linha em branco entre os grupos de diretivas using.

Exemplos de código:

// dotnet_separate_import_directive_groups = true
using System.Collections.Generic;
using System.Threading.Tasks;

using Octokit;

// dotnet_separate_import_directive_groups = false
using System.Collections.Generic;
using System.Threading.Tasks;
using Octokit;

Opções de namespace dotnet

Essas regras de formatação se refere à declaração de namespaces em C# e Visual Basic.

Exemplo de arquivo .editorconfig:

# .NET namespace rules
[*.{cs,vb}]
dotnet_style_namespace_match_folder = true

pasta dotnet _ style _ namespace _ _ match

Propriedade Valor
Nome da opção dotnet_style_namespace_match_folder
Idiomas aplicáveis C# e Visual Basic
Versão introduzida Visual Studio 2019 versão 16.10
Valores de opção true – Corresponder namespaces à estrutura de pastas

false - Não relatar namespaces que não corresponderem à estrutura de pastas

Exemplos de código:

// dotnet_style_namespace_match_folder = true
// file path: Example/Convention/C.cs
using System;

namespace Example.Convention
{
    class C
    {
    }
}

// dotnet_style_namespace_match_folder = false
// file path: Example/Convention/C.cs
using System;

namespace Example
{
    class C
    {
    }
}

Regras de formatação em C#

As regras de formatação nesta seção aplicam-se somente a código em C#.

  • Opções de nova linha
    • 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
  • Opções de recuo
    • csharp_indent_case_contents
    • csharp_indent_switch_labels
    • csharp_indent_labels
    • csharp_indent_block_contents
    • csharp_indent_braces
    • csharp_indent_case_contents_when_block
  • Opções de espaçamento
    • 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
  • Encapsular opções
    • csharp_preserve_single_line_statements
    • csharp_preserve_single_line_blocks
  • Usando opções de diretiva
    • csharp_using_directive_placement
  • Opções de namespace
    • csharp_style_namespace_declarations

Opções de nova linha

Essas regras de formatação envolvem o uso de novas linhas para formatar o código.

Exemplo de arquivo .editorconfig:

# 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

Essa regra está relacionada a se uma chave de abertura { devem ser colocada na mesma linha que a do código anterior ou em uma nova linha. Para essa regra, você especifica all, none ou um ou mais elementos de código, como métodos ou propriedades, para definir quando essa regra deve ser aplicada. Para especificar vários elementos de código, separe-os com uma vírgula (,).

Propriedade Valor
Nome da opção csharp_new_line_before_open_brace
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção all – requer que as chaves estejam em uma nova linha para todas as expressões (estilo "Allman").

none – requer que as chaves estejam na mesma linha para todas as expressões ("K&R").

accessors, anonymous_methods, anonymous_types, control_blocks, events, indexers, lambdas, local_functions, methods, object_collection_array_initializers, properties, types – requer que as chaves estejam em uma nova linha para o elemento de código especificado (estilo "Allman").

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_new_line_before_else
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – insira as instruções else em uma nova linha.

false – insira as instruções else na mesma linha.

Exemplos de código:

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

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

csharp_new_line_before_catch

Propriedade Valor
Nome da opção csharp_new_line_before_catch
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – insira as instruções catch em uma nova linha.

false – insira as instruções catch na mesma linha.

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_new_line_before_finally
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – exigir que as instruções finally estejam em uma nova linha após a chave de fechamento.

false – exigir que as instruções finally estejam na mesma linha como a chave de fechamento.

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_new_line_before_members_in_object_initializers
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – exigir que membros dos inicializadores de objetos estejam em linhas separadas

false – exigir que membros dos inicializadores de objetos estejam na mesma linha

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_new_line_before_members_in_anonymous_types
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – exigir que membros de tipos anônimos estejam em linhas separadas

false – exigir que membros de tipos anônimos estejam na mesma linha

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_new_line_between_query_expression_clauses
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – exigir que elementos das cláusulas de expressão de consulta estejam em linhas separadas

false – exigir que elementos das cláusulas de expressão de consulta estejam na mesma linha

Exemplos de código:

// 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;

Opções de recuo

Essas regras de formatação envolvem o uso de recuo para formatar o código.

Exemplo de arquivo .editorconfig:

# 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

Propriedade Valor
Nome da opção csharp_indent_case_contents
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – recuar switch conteúdo de caso

false – não recuar switch conteúdo de caso

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_indent_switch_labels
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – recuar switch rótulos

false – não recuar switch rótulos

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_indent_labels
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção flush_left – os rótulos são posicionados na coluna mais à esquerda

one_less_than_current – os rótulos são posicionados em um recuo a menos do que o contexto atual

no_change – os rótulos são posicionados no mesmo recuo do contexto atual

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_indent_block_contents
Idiomas aplicáveis C#
Valores de opção true -

false -

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_indent_braces
Idiomas aplicáveis C#
Valores de opção true -

false -

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_indent_case_contents_when_block
Idiomas aplicáveis C#
Valores de opção true -

false -

Exemplos de código:

// 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;
}

Opções de espaçamento

Essas regras de formatação envolvem o uso de caracteres de espaço para formatar o código.

Exemplo de arquivo .editorconfig:

# 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

Propriedade Valor
Nome da opção csharp_space_after_cast
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – inserir um caractere de espaço entre uma conversão e o valor

false – Remover o espaço entre a conversão e o valor

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_after_keywords_in_control_flow_statements
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – inserir um caractere de espaço após uma palavra-chave em uma instrução de fluxo de controle, como um loop for

false – remover um espaço após uma palavra-chave em uma instrução de fluxo de controle, como um loop for

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_parentheses
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção control_flow_statements – inserir espaço entre parênteses das instruções de fluxo de controle

expressions – inserir espaço entre os parênteses das expressões

type_casts – inserir espaço entre os parênteses nas conversões de tipo

Se você omitir essa regra ou usar um valor diferente de control_flow_statements, expressions ou type_casts, a configuração não será aplicada.

Exemplos de código:

// 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_before_colon_in_inheritance_clause

Propriedade Valor
Nome da opção csharp_space_before_colon_in_inheritance_clause
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.7
Valores de opção true – remover um caractere de espaço antes dos dois-pontos para bases ou interfaces em uma declaração de tipo

false – remover um espaço antes dos dois-pontos para bases ou interfaces em uma declaração de tipo

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_after_colon_in_inheritance_clause
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.7
Valores de opção true – inserir um caractere de espaço após os dois-pontos para bases ou interfaces em uma declaração de tipo

false – remover um espaço após os dois-pontos para bases ou interfaces em uma declaração de tipo

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_around_binary_operators
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.7
Valores de opção before_and_after – inserir espaço antes e depois do operador binário

none – remover espaços antes e depois do operador binário

ignore – ignorar espaços em torno de operadores binários

Se você omitir essa regra ou usar um valor diferente de before_and_after, none ou ignore, a configuração não será aplicada.

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_method_declaration_parameter_list_parentheses
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – posicionar um caractere de espaço após o parêntese de abertura e antes do parêntese de fechamento de uma lista de parâmetros de declaração de método

false – remover caracteres de espaço após o parêntese de abertura e antes do parêntese de fechamento de uma lista de parâmetros de declaração de método

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_method_declaration_empty_parameter_list_parentheses
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.7
Valores de opção true – inserir um espaço nos parênteses vazios da lista de parâmetros para uma declaração de método

false – remover um espaço nos parênteses vazios da lista de parâmetros para uma declaração de método

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_method_declaration_name_and_open_parenthesis
Idiomas aplicáveis C#
Valores de opção true – inserir um caractere de espaço entre o nome do método e o parêntese de abertura na declaração do método

false – remover um caractere de espaço entre o nome do método e o parêntese de abertura na declaração do método

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_method_call_parameter_list_parentheses
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – posicionar um caractere de espaço após o parêntese de abertura e antes do parêntese de fechamento de uma chamada de método

false – remover caracteres de espaço após o parêntese de abertura e antes do parêntese de fechamento de uma chamada de método

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_method_call_empty_parameter_list_parentheses
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.7
Valores de opção true – inserir espaço dentro dos parênteses da lista de argumentos vazia

false – remover espaço dentro dos parênteses da lista de argumentos vazia

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_method_call_name_and_opening_parenthesis
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.7
Valores de opção true – inserir espaço entre o nome da chamada de método e o parêntese de abertura

false – remover espaço entre o nome da chamada de método e o parêntese de abertura

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_after_comma
Idiomas aplicáveis C#
Valores de opção true – inserir espaço após uma vírgula

false – remover o espaço após uma vírgula

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_before_comma
Idiomas aplicáveis C#
Valores de opção true – inserir espaço antes de uma vírgula

false – remover espaço antes de uma vírgula

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_after_dot
Idiomas aplicáveis C#
Valores de opção true – inserir espaço após um ponto

false – remover o espaço após um ponto

Exemplos de código:

// csharp_space_after_dot = true
this. Goo();

// csharp_space_after_dot = false
this.Goo();

csharp_space_before_dot

Propriedade Valor
Nome da opção csharp_space_before_dot
Idiomas aplicáveis C#
Valores de opção true – inserir espaço antes de um ponto

false – remover espaço antes de um ponto

Exemplos de código:

// csharp_space_before_dot = true
this .Goo();

// csharp_space_before_dot = false
this.Goo();

csharp_space_after_semicolon_in_for_statement

Propriedade Valor
Nome da opção csharp_space_after_semicolon_in_for_statement
Idiomas aplicáveis C#
Valores de opção true – inserir espaço após cada ponto e vírgula em uma instrução for

false – remover espaço após cada ponto e vírgula em uma instrução for

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_before_semicolon_in_for_statement
Idiomas aplicáveis C#
Valores de opção true – inserir espaço antes de cada ponto e vírgula em uma instrução for

false – remover espaço antes de cada ponto e vírgula em uma instrução for

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_around_declaration_statements
Idiomas aplicáveis C#
Valores de opção ignore – não remover caracteres de espaço extra em instruções de declaração

false – remover caracteres de espaço extra em instruções de declaração

Exemplos de código:

// csharp_space_around_declaration_statements = ignore
int    x    =    0   ;

// csharp_space_around_declaration_statements = false
int x = 0;

csharp_space_before_open_square_brackets

Propriedade Valor
Nome da opção csharp_space_before_open_square_brackets
Idiomas aplicáveis C#
Valores de opção true – inserir espaço antes dos colchetes de abertura [

false – remover espaço antes dos colchetes de abertura [

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_empty_square_brackets
Idiomas aplicáveis C#
Valores de opção true – inserir espaço entre colchetes vazios [ ]

false – remover espaço entre colchetes vazios []

Exemplos de código:

// 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

Propriedade Valor
Nome da opção csharp_space_between_square_brackets
Idiomas aplicáveis C#
Valores de opção true – inserir caracteres de espaço em colchetes não vazios [ 0 ]

false – remover caracteres de espaço em colchetes não vazios [0]

Exemplos de código:

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

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

Encapsular opções

Essas regras de formatação referem-se ao uso de linhas únicas em comparação com linhas separadas para instruções e blocos de código.

Exemplo de arquivo .editorconfig:

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

csharp_preserve_single_line_statements

Propriedade Valor
Nome da opção csharp_preserve_single_line_statements
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – deixar instruções e declarações de membros na mesma linha

false – deixar instruções e declarações de membros em linhas diferentes

Exemplos de código:

//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

Propriedade Valor
Nome da opção csharp_preserve_single_line_blocks
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2017 versão 15.3
Valores de opção true – deixar bloco de códigos em uma linha única

false – deixar bloco de códigos em linhas separadas

Exemplos de código:

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

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

Usando opções de diretiva

Essa regra de formatação se refere ao uso do uso de diretivas que estão sendo colocadas dentro e fora de um namespace.

Exemplo de arquivo .editorconfig:

# 'using' directive preferences
[*.cs]
csharp_using_directive_placement = outside_namespace
csharp_using_directive_placement = inside_namespace

csharp_using_directive_placement

Propriedade Valor
Nome da opção csharp_using_directive_placement
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2019 versão 16.1
Valores de opção outside_namespace -Deixar de usar diretivas fora do namespace

inside_namespace – Deixar as diretivas de uso dentro do namespace

Exemplos de código:

// csharp_using_directive_placement = outside_namespace
using System;

namespace Conventions
{

}

// csharp_using_directive_placement = inside_namespace
namespace Conventions
{
    using System;
}

Opções de namespace

Essas regras de formatação se refere ao estilo e às restrições de nomenclação para declarações de namespace.

Exemplo de arquivo .editorconfig:

# CSharp formatting rules:
[*.cs]
csharp_style_namespace_declarations = file_scoped

csharp_style_namespace_declarations

Propriedade Valor
Nome da opção csharp_style_namespace_declarations
Idiomas aplicáveis C#
Versão introduzida Visual Studio 2019 versão 16.10
Valores de opção block_scoped - As declarações de namespace devem usar escopos de bloco para declaração.

file_scoped - As declarações de namespace devem ter escopo de arquivo. Para obter mais informações, consulte a especificação de namespaces com escopo de arquivo.
// csharp_style_namespace_declarations = block_scoped
using System;

namespace Convention
{
    class C
    {
    }
}

// csharp_style_namespace_declarations = file_scoped
using System;

namespace Convention;
class C
{
}
Itens do projeto

dotnet_style_namespace_match_folder exige que o analisador tenha acesso às propriedades do projeto para funcionar corretamente.

Para projetos destinados ao .NET Core 3.1 ou uma versão anterior, você deve adicionar manualmente os itens a seguir ao arquivo de projeto. (Eles são adicionados automaticamente para o .NET 5 e superior.)

  <ItemGroup>
    <CompilerVisibleProperty Include="RootNamespace" />
    <CompilerVisibleProperty Include="ProjectDir" />
  </ItemGroup>

Confira também