c# - tutorial - stylecop visual studio 2017

¿Dónde está el archivo de configuración de Stylecop?

Question

He instalado Stylecop a través de NuGet. Deseo deshabilitar algunas reglas, y sé que esto se puede hacer a través de un archivo de configuración de lo que he leído. Sin embargo, no puedo encontrar el archivo en ninguna parte y parece que hay poca documentación que describe dónde crear el archivo.

¿Cómo hago para hacer el archivo?

Edit : Como esta pregunta aún parece estar recibiendo atención un par de años más tarde, recomiendo usar StyleCop basado en Roslyn Analyzer ahora.

Esto tiene algunas ventajas:

1. En realidad se mantiene y activa.
2. Aprovecha a Roslyn y puede realizar algunos cambios por ti.
3. Es un paquete de NuGet, por lo que se instala como parte de sus proyectos, lo que significa que ya no necesita instalar la extensión de Visual Studio StyleCop que parece que no se ha mantenido (¡eso es si puede encontrar el lugar adecuado para descargarlo desde el principio!) De esta manera puede hacer cumplir el estilo de código / convenciones mucho más fácilmente, por ejemplo, en OSS.
4. Crea automáticamente el archivo .ruleset por usted, y como resultado del uso de los analizadores Roslyn, obtiene soporte IDE para habilitar / deshabilitar reglas.

Answer 1

El archivo Settings.StyleCop debería estar ubicado en su directorio de instalación, en mi máquina está aquí:

C: / Archivos de programa (x86) / StyleCop 4.7 / Settings.StyleCop

Puede editar la configuración de la regla abriendo este archivo con StyleCopSettingsEditor.exe , ubicado en el mismo directorio (hacer doble clic en el archivo de configuración hará el truco).

Answer 2

Si copia el archivo StyleCop.Settings en la raíz de la solución, todos los proyectos lo heredarán. Esto significa que se puede mantener en Source Control y se puede acceder a él desde cualquier servidor de integración continua que esté utilizando.

Si hace referencia y modifica el archivo en C:/Program Files (x86)/StyleCop {{version}}/Settings.StyleCop esto debe mantenerse en línea en la PC de cada desarrollador. Donde como copiarlo a la raíz de la solución.

Answer 3

Si instaló Stylecop a través de NuGet (el paquete StyleCop.MSBuild ), entonces no tendrá la carpeta detallada en las otras respuestas.

Encontrará el archivo en la carpeta de su proyecto aquí:
packages / StyleCop.MSBuild. {versión} / tools / Settings.StyleCop

Debes copiar este archivo a la raíz de tu proyecto.

Si prefiere no editar manualmente el archivo, también hay una buena herramienta de interfaz gráfica de usuario llamada StyleCopSettingsEditor en la carpeta de herramientas, en la que puede arrastrar el archivo de configuración.