Preferências de estilo de código
Você pode definir configurações de estilo de código por projeto usando um arquivo EditorConfigou para todo o código editado no Visual Studio no editor de texto Opções página. Para código C#, você também pode configurar o Visual Studio para aplicar essas preferências de estilo de código usando os comandos Code Cleanup (Visual Studio 2019, Visual Studio 2022) e Format Document (Visual Studio 2017).
Estilos de código em arquivos EditorConfig
Você pode preencher manualmente seu arquivo EditorConfig ou pode gerar automaticamente o arquivo com base nas configurações de estilo de código escolhidas na caixa de diálogo Opções de do Visual Studio. Esta página de opções está disponível em Tools>Options>Text Editor> [C# ou Basic] >Code Style>General. Clique em Gerar arquivo .editorconfig a partir das configurações para gerar automaticamente um arquivo de estilo de codificação .editorconfig com base nas configurações desta página de Opções.
Você pode configurar manualmente o seu arquivo EditorConfig, ou pode gerar automaticamente o arquivo com base nas definições do estilo de código escolhidas na caixa de diálogo Opções do Visual Studio. Esta página de opções está disponível em Ferramentas>Opções>Editor de Texto> [C# ou Visual Basic] >Code Style>General. Clique
Estilos de código na caixa de diálogo Opções
As preferências de estilo de código podem ser definidas para todos os seus projetos C# e Visual Basic abrindo a caixa de diálogo Opções a partir do menu Ferramentas. Na caixa de diálogo Opções de , selecione Editor de Texto> [C# ou Visual Basic] >Estilo de Código>Geral .
As preferências de estilo de código podem ser definidas para todos os seus projetos C# e Visual Basic abrindo a caixa de diálogo Opções de
Cada item na lista mostra uma visualização da preferência quando selecionado:
As opções definidas nesta janela são aplicáveis à sua conta de personalização do Visual Studio e não estão associadas a um projeto ou base de código específico. Além disso, eles não são aplicados no momento da compilação, inclusive em compilações de integração contínua (CI). Se você quiser associar preferências de estilo de código ao seu projeto e ter os estilos aplicados durante a compilação, especifique as preferências em um arquivo .editorconfig associado ao projeto.
Preferência e gravidade
Para cada configuração de estilo de código nesta página, pode definir os valores de Preferência e Severidade usando os menus suspensos em cada linha. A severidade pode ser definida como Apenas Refatoração, Sugestão, Aviso , ou Erro . Caso pretenda habilitar as Ações Rápidas para um estilo de código, assegure-se de que a configuração de Gravidade esteja definida como algo diferente de Apenas Refatoração. O ícone
Aplicar regras de estilo de código na compilação
A partir do Visual Studio 2019 versão 16.8, que inclui o SDK do .NET 5.0 RC2, você pode impor as convenções de codificação do .NET no de compilação para todos os projetos .NET. No momento da compilação, as violações de estilo de código .NET aparecerão como avisos ou erros com um prefixo "IDE". Isso permite que você imponha estritamente estilos de código consistentes em sua base de código.
Aplicar estilos de código
Para arquivos de código C#, o Visual Studio tem um botão Code Cleanup na parte inferior do editor (teclado: Ctrl+KCtrl+E) para aplicar estilos de código de um arquivo EditorConfig ou da página de opções Code Style. Se existir um arquivo de .editorconfig
Dica
As regras configuradas com uma severidade de Nenhum não participam na limpeza de código, mas podem ser aplicadas individualmente através do menu de Ações Rápidas e Refatorações.
Para aplicar estilos de código:
Primeiro, configure quais estilos de código você deseja aplicar (em um dos dois perfis) na caixa de diálogo Configurar Limpeza de Código. Para abrir essa caixa de diálogo, clique na seta de expansão ao lado do ícone da vassoura de limpeza de código e escolha Configurar limpeza de código.
Depois de configurar a limpeza de código, use um dos seguintes métodos para executar a limpeza de código:
Clique no ícone da vassoura ou pressione Ctrl+K, Ctrl+E para executar a limpeza de código.
Para executar a limpeza de código em todo o projeto ou solução, clique com o botão direito do mouse no nome do projeto ou da solução no Gerenciador de Soluções , selecione Analisar e Limpeza de Código e, em seguida, selecione Executar Limpeza de Código.
Se você quiser que suas configurações de estilo de código sejam aplicadas toda vez que salvar um arquivo, você pode gostar da extensão Code Cleanup on Save.
Para arquivos de código C#, o Visual Studio tem um botão Code Cleanup na parte inferior do editor (teclado: Ctrl+KCtrl+E) para aplicar estilos de código de um arquivo EditorConfig ou da página de opções Code Style. Se existir um arquivo de .editorconfig
Dica
As regras configuradas com uma severidade de Nenhum não participam na limpeza de código, mas podem ser aplicadas individualmente através do menu Ações Rápidas e Refatorações.
Para aplicar estilos de código:
Primeiro, configure quais estilos de código você deseja aplicar (em um dos dois perfis) na caixa de diálogo Configurar Limpeza de Código. Para abrir essa caixa de diálogo, clique na seta de expansão ao lado do ícone da vassoura de limpeza de código e escolha Configurar limpeza de código.
Depois de configurar a limpeza de código, use um dos seguintes métodos para executar a limpeza de código:
Clique no ícone da vassoura ou pressione Ctrl+K, Ctrl+E.
Para executar a limpeza de código em todo o projeto ou solução, clique com o botão direito do mouse no nome do projeto ou da solução no Gerenciador de Soluções , selecione Analisar e Limpeza de Código e, em seguida, selecione Executar Limpeza de Código.
Se você quiser que suas configurações de estilo de código sejam aplicadas sempre que salvar um arquivo, vá para Opções de >Editor de Texto> de Limpeza de Código e selecione perfil Executar Limpeza de Código ao salvar.
Configurações de limpeza de código
A maioria das configurações de limpeza de código são mapeadas para um ou mais estilos de código .NET suportados em .editorconfig. Para obter exemplos que mostram os efeitos das configurações, use os links na tabela a seguir.
| Cenário | ID da regra ou opção de estilo |
|---|---|
| Remover importações ou utilizações desnecessárias | IDE0005 |
| Ordenar importações ou utilizações |
dotnet_sort_system_directives_first dotnet_separate_import_directive_groups |
| Aplicar preferências de cabeçalho de arquivo | file_header_template |
| Remover variáveis não utilizadas | CS0219 |
| Aplicar preferências de criação de objetos | visual_basic_style_prefer_simplified_object_creation |
| Aplicar preferências de IsNot | visual_basic_style_prefer_isnot_expression |
| Adicionar qualificação 'isto' ou 'Eu' | IDE0003-IDE0009 |
| Adicionar modificadores de acessibilidade | dotnet_style_require_accessibility_modifiers |
| Modificadores de ordem | IDE0036 |
| Tornar o campo só de leitura | dotnet_style_readonly_field |
| Remover moldes desnecessários | IDE0004 |
| Aplicar parâmetros de inicialização de objeto/coleção) | dotnet_style_object_initializer |
| Aplicar usando as preferências de posicionamento de diretiva | csharp_using_directive_placement |
| Aplicar preferências entre parênteses | IDE0047-IDE0048 |
| Aplicar preferências de valor não utilizadas | IDE0058 |
| Aplicar preferências de tipo de idioma/estrutura | IDE0049 |
| Remover supressões não utilizadas | dotnet_remove_unnecessary_suppression_exclusions |
| Aplicar preferências de expressão booleana simplificada | dotnet_style_prefer_simplified_boolean_expressions |
| Aplicar preferências de interpolação de cadeia de caracteres | dotnet_style_prefer_simplified_interpolation |
| Remover parâmetros não utilizados | dotnet_code_quality_unused_parameters |
| Aplicar preferências de propriedade automática | dotnet_style_prefer_auto_properties |
| Aplicar preferências de atribuição composta | dotnet_style_prefer_compound_assignment |
| Aplicar preferências para a expressão de coalescência | dotnet_style_coalesce_expression |
| Aplicar preferências de expressão condicional |
dotnet_style_prefer_conditional_expression_over_assignment dotnet_style_prefer_conditional_expression_over_return |
| Aplicar preferências de nome de tupla |
dotnet_style_explicit_tuple_names dotnet_style_prefer_inferred_tuple_names |
| Aplicar preferências de nomes de membros de tipo anônimo inferido | dotnet_style_prefer_inferred_anonymous_type_member_names |
| Aplicar preferências de verificação nula | dotnet_style_prefer_is_null_check_over_reference_equality_method |
| Aplicar preferências de propagação nula | dotnet_style_null_propagation |
| Aplicar preferências de variáveis | IDE0007-IDE0008 |
| Adicionar as chaves necessárias para declarações de controlo de linha única | csharp_prefer_braces |
| Aplicar preferências de expressão ou corpo de bloco | Membros com corpo de expressão |
| Aplicar preferências de variáveis 'out' embutidas | csharp_style_inlined_variable_declaration |
| Aplicar preferências de correspondência de padrões | Preferências de reconhecimento de padrões |
| Aplicar preferências de chamada de delegado condicional | csharp_style_conditional_delegate_call |
| Aplicar preferências de função local estática | csharp_prefer_static_local_function |
| Aplicar as preferências de desconstrução | csharp_style_deconstructed_variable_declaration |
| Aplicar preferências padrão(T) | csharp_prefer_simple_default_expression |
| Aplicar novas() preferências | estilo_csharp_criação_implícita_de_objetos_quando_o_tipo_é_aparente |
| Aplicar preferências de intervalo | csharp_style_prefer_range_operator |
| Aplicar preferências por funções locais em vez de anónimas | csharp_style_pattern_local_over_anonymous_function |
| Aplicar preferências nulas de parâmetro | Preferências de verificação nula |
| Aplicar usando preferências de declarações | csharp_prefer_simple_using_statement |
| Aplicar preferências de expressão de lançamento | csharp_style_throw_expression |
::: Apelido-fim