2011-11-17 12 views
8

Estamos usando ReSharper 6.0 con StyleCop para ReSharper.ReSharper: cómo deshabilitar la generación de encabezados de documentación de basura en Code Cleanup

Aunque utilizamos la regla de StyleCop de que los miembros deben tener encabezados de documentación, no queremos que el servicio de limpieza de código de ReSharper genere encabezados de documentación para nosotros, porque inevitablemente son basura. Los encabezados de documentos incorrectos son peores que ninguno en absoluto porque es menos probable que se actualicen de los que se agregaron en primer lugar.

Intentamos desactivar la configuración 'Insertar texto en la documentación y los encabezados de los archivos' en ReSharper => Opciones => Herramientas => StyleCop, pero se reinicia automáticamente al reiniciar Visual Studio.

¿Alguna idea de cómo podemos detener la limpieza de código creando encabezados de documentación para nosotros?

Respuesta

8

ReSharper -> Options -> Tools section -> Code Cleanup -> select StyleCop profile -> Documentation section -> untick 1600.

Will evitar que los encabezados de documentación por defecto se crean pero todavía StyleCop hará cumplir la que deberían estar allí.

+3

Para mí, tuve que configurar '1639: Actualizar encabezado de archivo' a' No cambiar'. – Iain

+1

Además, si usa un encabezado de archivo personalizado y no desea reemplazarlo con el encabezado estándar de StyleCop, desmarque '1633-1641: Actualizar encabezado de archivo 'en StyleCop -> Documentación. –

0

El segundo paso, después de bloquear la generación de código es eliminar la basura. Utilicé una búsqueda/reemplazo regex a través de Visual Studio.

expresión regular es de cabecera:

// ---.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n.*\r\n\/\/.-{116} 

expresión regular para eliminar los resúmenes generados

\s{4}\/\/\/\s<summary>(.*)\r\n.*\r\n.*</summary> 

Precaución: se eliminará todos los resúmenes, incluso los buenos, a fin de comprobar el alcance de reemplazo antes de lanzarlo. (El pago de git podría ser tu amigo ...)

Cuestiones relacionadas