Preferencias de estilo de código y limpieza de código

Las preferencias de estilo de código te permiten controlar aspectos del código, como el estilo de sangría, el ancho de tabulación, los caracteres de final de línea, la codificación y muchas otras opciones de formato. Puede definir la configuración de estilo de código de dos maneras:

• Por base de código o por proyecto mediante un archivo EditorConfig o
• Para todo el código que edite en Visual Studio en función de la configuración de la página Opciones de .NET del editor de texto o en la página Opciones de C/C++.

También puede configurar Visual Studio para aplicar preferencias de estilo de código mediante los comandos Limpieza de código y Formato de documento .

Estilos de código en archivos EditorConfig

La configuración de estilo de código se puede especificar agregando un archivo EditorConfig al proyecto. Los archivos EditorConfig están asociados a un código base en lugar de a una cuenta de personalización de Visual Studio. La configuración de un archivo EditorConfig tiene prioridad sobre los estilos de código que se especifican en el cuadro de diálogo Opciones. Use un archivo EditorConfig cuando quiera aplicar estilos de codificación para todos los colaboradores en el repositorio o proyecto. Son especialmente útiles para garantizar la coherencia en un entorno de programación de equipos.

Para agregar un archivo EditorConfig, consulte Formas de agregar un archivo EditorConfig.

Para obtener información de referencia sobre la configuración de estilo de código de .NET, consulte Configuración de estilo de código.

Estilos de código de C/C++ en el cuadro de diálogo Opciones

Puede especificar numerosas opciones de formato de código individuales, como la sangría y las posiciones de corchetes. Para ello, vaya a Herramientas>Opciones>Editor> de textoC/C++>Formato de estilo> de código (o escriba Ctrl + Q y busque "Formato"). Como alternativa, puede especificar uno de los estilos ClangFormat (o su propio estilo de ClangFormat personalizado).

Para obtener más información sobre todas las opciones de formato, vea Opciones, Editor de texto, C/C++, Formato.

Estilos de código de .NET en el cuadro de diálogo Opciones

Puede establecer las preferencias de estilo de código de los proyectos de C# y Visual Basic abriendo el cuadro de diálogo Opciones desde el menú Herramientas. En el cuadro de diálogo Opciones, seleccione Editor> de texto [C# o Estilo de código>].

• Para los estilos de formato, seleccione opciones en Formato.
• Para las preferencias de estilo de código asociadas a acciones rápidas y reglas de estilo de código IDE, seleccione opciones en General o Nomenclatura.

Cada elemento de la lista muestra una vista previa de la preferencia al seleccionar la opción:

Las opciones establecidas en esta ventana son aplicables a la cuenta de personalización de Visual Studio y no están asociadas a un proyecto o código base determinado. Además, no se aplican en tiempo de compilación, incluidas las compilaciones de integración continua (CI). Si desea asociar preferencias de estilo de código al proyecto y aplicar los estilos durante la compilación, especifique las preferencias en un archivo EditorConfig asociado al proyecto.

Preferencia y gravedad

Para cada configuración de estilo de código en las páginas de opciones General y Nomenclatura, puede establecer los valores de Preferencia y de Gravedad mediante las listas desplegables de cada línea. La gravedad se puede establecer en Solo refactorización, Sugerencia, Advertencia o Error.

• Las preferencias de estilo de código en las páginas de opciones General y Nomenclatura determinan las acciones rápidas para un estilo de código. El icono de bombilla Acciones rápidas, el icono de bombilla de error , o el icono de destornillador aparecen cuando se usa un estilo no preferido, pero puede elegir una opción en la lista Acciones rápidas para volver a escribir el código automáticamente en el estilo preferido.
• Si desea que la infracción aparezca solo como una acción rápida y también se excluya de la limpieza del código, establezca gravedad en Refactorización solo.
• Si desea que la infracción aparezca en la ventana Lista de errores, así como acciones rápidas, y se incluya en la limpieza de código, establezca gravedad enSugerencia, Advertencia o Error. Las infracciones aparecen como sugerencia (mensaje), advertencia o error al establecer la salida en la ventana Lista de errores en Compilar + IntelliSense. Se excluyen de solo la salida Build.

La configuración de un archivo EditorConfig tiene prioridad sobre los estilos de código establecidos en estas páginas.

Forzar el cumplimiento de estilos de código durante la compilación

A partir de la versión 16.8 de Visual Studio 2019, que incluye el SDK de .NET 5.0 RC2, puede aplicar las convenciones de codificación de .NET en la compilación para todos los proyectos de .NET. En tiempo de compilación, las infracciones de estilo de código de .NET aparecerán como advertencias o errores con un prefijo "IDE". Esto le permite aplicar estrictamente estilos de código coherentes en el código base.

Aplicar estilos de código

Al cambiar un estilo de código en la página Opciones o agregar un archivo EditorConfig al proyecto en Visual Studio, solo se da formato a nuevas líneas de código en función de la nueva configuración. El formato del código existente no cambia a menos que ejecute uno de los siguientes comandos:

• Limpieza de código.

  Seleccione Limpieza de código en el editor de Visual Studio o presione Ctrl+K, Ctrl+E. Este comando se aplica a los ajustes de espacio en blanco, como el estilo de sangría, y a las configuraciones de estilo de código seleccionadas, como las preferencias de paréntesis.

• Dar formato al documento.

  Seleccione Editar>Documento con formato avanzado>o presione Ctrl+K, Ctrl+D en el perfil predeterminado. Este comando solo se aplica a configuraciones de espacio en blanco, como el estilo de sangría.

Aplicar estilos de código mediante la limpieza de código

Para aplicar estilos de código desde un archivo EditorConfig o desde la página Opciones de estilo de código, use el botón Limpieza de código en la parte inferior del editor (teclado: CtrlK, ++E). Si existe un archivo EditorConfig para el proyecto, se trata de la configuración que tiene prioridad.

Sugerencia

Las reglas de .NET configuradas con una gravedad de Refactorización Solo no participan en la limpieza de código, pero se pueden aplicar individualmente a través del menú Acciones rápidas y refactorizaciones .

Para aplicar estilos de código:

1. En primer lugar, configure qué estilos de código desea aplicar en el cuadro de diálogo Configurar limpieza de código (en uno de los dos perfiles). Para abrir este cuadro de diálogo, haga clic en la flecha desplegable junto al icono de la escoba de limpieza de código y, a continuación, elija Configurar limpieza de código. Como alternativa, use el menú Analizar>limpieza de código .

   

   Para obtener un mapeo de soluciones de limpieza de código de .NET a reglas de estilo de código de .NET, vea Configuración de limpieza de código de .NET.

   Las opciones de C/C++ incluyen C++ en el nombre del solucionador.

2. Después de configurar la limpieza de código, use uno de los métodos siguientes para ejecutar la limpieza de código:

   • Haga clic en el icono de escoba o presione Ctrl+K, Ctrl+E.

     

   • Para ejecutar la limpieza de código en todo el proyecto o solución, haga clic con el botón derecho en el nombre del proyecto o la solución en el Explorador de soluciones, seleccione Analizar y limpiar código y, a continuación, seleccione Ejecutar limpieza de código.

     

3. (Opcional) Si desea que la configuración de estilo de código se aplique cada vez que guarde un archivo, vaya a Opciones> Editor detexto>Limpieza de código y seleccione Ejecutar perfil de limpieza de código en guardar.

Configuración de limpieza de código de .NET

La mayoría de la configuración de limpieza de código se asignan a uno o varios estilos de código .NET admitidos en EditorConfig. Para ver ejemplos que muestran los efectos de la configuración, use los vínculos de la tabla siguiente.

Ajuste	Id. de regla o opción de estilo
Quitar importaciones o usos innecesarios	IDE0005
Ordenar importaciones o usos	dotnet_ordenar_directivas_sistema_primero dotnet_separar_grupos_de_directivas_importación
Aplicar preferencias de encabezado de archivo	file_header_template
Eliminación de variables no utilizadas	CS0219
Aplicar preferencias de creación de objetos	visual_basic_style_preferir_creación_de_objetos_simplificada
Aplicar las preferencias de IsNot	visual_basic_style_prefer_isnot_expression
Agregar calificación "this" o "Me"	IDE0003-IDE0009
Adición de modificadores de accesibilidad	dotnet_style_require_modificadores_de_accesibilidad
Modificadores de pedido	IDE0036
Hacer que el campo sea de solo lectura	dotnet_style_readonly_field
Quitar conversiones innecesarias	IDE0004
Aplicar parámetros de inicialización de objeto/colección)	dotnet_style_object_initializer
Aplicar usando las preferencias de selección de ubicación de directiva	csharp_using_directive_placement
Aplicar preferencias entre paréntesis	IDE0047-IDE0048
Aplicar preferencias de valor no utilizadas	IDE0058
Aplicar preferencias de tipo de lenguaje o marco	IDE0049
Elimina las supresiones sin usar	dotnet_remove_unnecessary_suppression_exclusions
Aplicar preferencias para simplificar expresiones booleanas	dotnet_style_prefer_simplified_boolean_expressions
Aplicar preferencias de interpolación de cadenas	dotnet_style_prefer_simplified_interpolation
Eliminación de parámetros sin usar	dotnet_code_quality_unused_parameters
Aplicar preferencias de propiedades automáticas	dotnet_style_prefer_auto_properties
Aplicar preferencias de asignación compuesta	dotnet_style_prefer_compound_assignment
Aplicación de preferencias de expresiones de fusión	dotnet_style_coalesce_expression
Aplicar preferencias de expresión condicional	dotnet_style_prefer_conditional_expression_over_assignmentdotnet_style_prefer_conditional_expression_over_return
Aplicar preferencias de nombre de tupla	dotnet_style_explicit_tuple_namesdotnet_style_prefer_inferred_tuple_names
Aplicar preferencias de nombres de miembros de tipo anónimo inferidos	dotnet_style_prefer_inferred_anonymous_type_member_names
Aplicar preferencias de comprobación NULL	dotnet_style_prefer_is_null_check_over_reference_equality_method
Aplicar preferencias de propagación nulas	dotnet_style_null_propagation
Aplicar preferencias \\"var\\"	IDE0007-IDE0008
Agregar las llaves necesarias para las instrucciones de control de una sola línea	csharp_prefer_braces
Aplicar preferencias de cuerpo de expresiones o bloques	Miembros con forma de expresión
Aplicar preferencias de variables "out" insertadas	csharp_style_inlined_variable_declaration
Aplicar preferencias de coincidencia de patrones	Preferencias de coincidencia de patrones
Aplicación de preferencias de llamada de delegado condicional	csharp_style_conditional_delegate_call
Aplicación de preferencias de función local estática	csharp_prefer_static_local_function
Aplicar preferencias deconstrucción	csharp_style_deconstructed_variable_declaration
Aplicar preferencias predeterminadas(T)	csharp_prefer_simple_default_expression
Aplicar preferencias new()	csharp_estilo_creación_implícita_objeto_cuando_tipo_es_aparente
Aplicar preferencias de intervalo	estilo_csharp_preferir_operador_de_rango
Aplicar preferencias de función local sobre las anónimas.	csharp_style_pattern_local_over_anonymous_function
Aplicar preferencias nulas de parámetro	Preferencias de la comprobación de NULL
Aplicar preferencias de instrucción using	csharp_prefer_simple_using_statement (preferencia por instrucciones 'using' simples en C#)
Aplicar preferencias de la expresión throw	csharp_style_throw_expression

Contenido relacionado

• Acciones Rápidas
• Configuraciones de las convenciones de codificación de .NET para EditorConfig