es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

‘Format code’ y ‘sort using’ al guardar en Visual Studio 2022

Yo y mi equipo hemos pasado los últimos meses definiendo reglas sobre el formato y estilo del código C# para nuestro proyecto, por lo que terminamos con un archivo .editorconfig.

Además, todos instalamos la extensión Productivity Power Tools para formatear el código al guardar el archivo (CTRL + S) en lugar de tener que utilizar la función incorporada de VS, Code Clean Up. Tomamos esta decisión cuando nos dimos cuenta de que esto último requiere un atajo especial (CTRL + K, CTRL + E) y que cada miembro del equipo necesita configurar esta opción localmente, ya que no hay forma de ponerla en el control de origen.

Esta forma de trabajar fue genial con VS 2019.

Sin embargo, el último mes, la mayoría de los miembros del equipo actualizó a VS 2022 y la extensión Productivity Power Tools 22 eliminó, aparentemente sin motivo alguno, las funciones Format On Save y Remove and Sort Usings on save.

Aparentemente, solucionamos este problema con la extensión VSE-FormatDocumentOnSave – configurando Edit.FormatDocument Edit.RemoveAndSort en la opción Commands. Parece funcionar muy bien, pero nuestra preocupación es el hecho de que no es una herramienta de Microsoft y quién sabe qué sucederá en el futuro.

Entonces, dado que el estilo y las reglas de formato del código son una preocupación para todos los equipos, me gustaría saber si alguien conoce una mejor manera de manejar esto, considerando que somos un equipo de más de 20 desarrolladores.

Tags:  , , ,

Answer

  1. Avatar for davy.ai

    Gestión de las reglas de formato y estilo de código para un equipo en Visual Studio

    Como experto en TI en Visual Studio con enfoque en el formato y estilo de código, entiendo la importancia de mantener un código consistente en un equipo de desarrolladores. Mi equipo y yo pasamos varios meses definiendo reglas sobre el formato y estilo del código C# y terminamos con un archivo .editorconfig para hacer cumplir estas reglas.

    También instalamos la extensión ‘Productivity Power Tools’ para formatear el código al guardar, en lugar de depender de la función integrada ‘Code Clean Up’ de VS. Sin embargo, cuando algunos miembros del equipo actualizaron a VS 2022, las funciones ‘Format On Save’ y ‘Remove and Sort Usings on save’ fueron eliminadas de la extensión ‘Productivity Power Tools 22’ sin ninguna explicación.

    Para superar este problema, comenzamos a utilizar la extensión ‘VSE-FormatDocumentOnSave’, la cual parece funcionar bien, pero nos preocupa depender de una herramienta que no es de Microsoft. Por lo tanto, estoy buscando una mejor manera de gestionar las reglas de estilo y formato de código para nuestro equipo de más de 20 desarrolladores.

    Un enfoque que recomiendo es incluir el archivo .editorconfig en el control de origen, de modo que cada miembro del equipo tenga las mismas reglas de formato impuestas. Además, podemos utilizar la función integrada ‘Code Clean Up’ de VS y configurarla para que se ajuste a nuestras reglas de formato de código. Luego, podemos utilizar las opciones de VS para exportar nuestra configuración preferida de estilo de código e integrarla en el archivo .editorconfig. Esto asegura que cada miembro del equipo tenga la misma configuración y pueda aplicarla fácilmente.

    Otra opción es utilizar una herramienta de terceros como ReSharper o StyleCop, las cuales proporcionan opciones avanzadas de análisis y formato de código, y se pueden configurar para que se ajusten a nuestras reglas de formato de código. Sin embargo, estas herramientas pueden ser costosas y pueden requerir capacitación adicional.

    En resumen, la gestión de reglas de formato y estilo de código en un equipo requiere una combinación de herramientas, técnicas y mejores prácticas. Al utilizar el control de origen, las características integradas de VS y las herramientas de terceros, podemos asegurarnos de que nuestro código sea consistente y fácil de leer, reduciendo errores y mejorando la productividad.

Comments are closed.