Opciones de reglas de estilo de código

  • Artículo

Puede definir y mantener un estilo de código coherente en el código base definiendo reglas de estilo de código de .NET y sus opciones asociadas en un archivo de configuración. Estas reglas están expuestas por varios IDE de desarrollo, como Visual Studio, a medida que se edita el código. En el caso de los proyectos .NET, estas reglas también se pueden aplicar en tiempo de compilación. Puede habilitar o deshabilitar reglas individuales y configurar el grado en que quiere que se aplique cada regla, a través de un nivel de gravedad.

Sugerencia

  • Al definir las opciones de estilo de código en un archivo EditorConfig, configura cómo quiere que los analizadores de estilo de código analicen el código. El archivo EditorConfig es el archivo de configuración de estos analizadores.

  • Las opciones de estilo de código también se pueden establecer en Visual Studio en el cuadro de diálogo Opciones del editor de texto. Se trata de opciones por usuario que solo se respetan durante la edición en Visual Studio. Estas opciones no se respetan en tiempo de compilación ni en otros IDE. Además, si el proyecto o la solución abiertos en Visual Studio tienen un archivo EditorConfig, tienen prioridad las opciones del archivo EditorConfig. En Visual Studio en Windows, también puede generar un archivo EditorConfig a partir de las opciones del editor de texto. Seleccione Herramientas>Opciones>Editor de texto> [C# o Basic] >Code Style>General y, luego, haga clic en Generar archivo .editorconfig a partir de la configuración. Para obtener más información, vea Preferencias de estilo del código.

Las reglas de estilo de código se dividen en las subcategorías siguientes:

Cada una de estas subcategorías define su propia sintaxis para especificar opciones. Para obtener más información sobre estas reglas y las opciones correspondientes, vea la referencia sobre las reglas de estilo de código.

Ejemplo del archivo EditorConfig

Para ayudarle a empezar, aquí tiene un archivo .editorconfig de ejemplo con las opciones predeterminadas.

Nota

La sintaxis concisa que se ve en este archivo, donde la gravedad se especifica después del valor de opción para las reglas de lenguaje, por ejemplo, dotnet_style_readonly_field = true:suggestion, solo Visual Studio lo entiende completamente. Los compiladores no entienden el sufijo :<severity-level> y se omiten si compila el código desde la línea de comandos. Para establecer la gravedad de una manera que Visual Studio y los compiladores de C# y Visual Basic entienda, establezca la gravedad en la regla que contiene la opción mediante la sintaxis siguiente:

dotnet_diagnostic.<rule-ID>.severity = <severity-level>

Para más información, vea Formato de opción.

Sugerencia

###############################
# Core EditorConfig Options   #
###############################
root = true
# All files
[*]
indent_style = space

# XML project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
indent_size = 2

# XML config files
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
indent_size = 2

# Code files
[*.{cs,csx,vb,vbx}]
indent_size = 4
insert_final_newline = true
charset = utf-8-bom
###############################
# .NET Coding Conventions     #
###############################
[*.{cs,vb}]
# Organize usings
dotnet_sort_system_directives_first = true
# this. preferences
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_property = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_event = false:silent
# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent
# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
dotnet_style_readonly_field = true:suggestion
# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
###############################
# Naming Conventions          #
###############################
# Style Definitions
dotnet_naming_style.pascal_case_style.capitalization             = pascal_case
# Use PascalCase for constant fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds            = field
dotnet_naming_symbols.constant_fields.applicable_accessibilities  = *
dotnet_naming_symbols.constant_fields.required_modifiers          = const
###############################
# C# Coding Conventions       #
###############################
[*.cs]
# var preferences
csharp_style_var_for_built_in_types = true:silent
csharp_style_var_when_type_is_apparent = true:silent
csharp_style_var_elsewhere = true:silent
# Expression-bodied members
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_operators = false:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
# Pattern matching preferences
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
# Null-checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion
# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:suggestion
# Expression-level preferences
csharp_prefer_braces = true:silent
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_prefer_local_over_anonymous_function = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
###############################
# C# Formatting Rules         #
###############################
# New line preferences
csharp_new_line_before_open_brace = all
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
# Indentation preferences
csharp_indent_case_contents = true
csharp_indent_switch_labels = true
csharp_indent_labels = flush_left
# Space preferences
csharp_space_after_cast = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
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_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
# Wrapping preferences
csharp_preserve_single_line_statements = true
csharp_preserve_single_line_blocks = true
###############################
# VB Coding Conventions       #
###############################
[*.vb]
# Modifier preferences
visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion

Consulte también