2009-06-05 12 views
5

Tengo un código que estoy manteniendo que tiene una buena cantidad de comentarios generados por la máquina y regiones generadas por la máquina. (O creado por un desarrollador particular engañado)Cómo quitar los robo-comentarios y #region de C#?

Estos son los comentarios que se repiten en exclusiva los metadatos y el espacio expansiones método de nombres entubados pascal:

#region methods 
/// <summary> 
/// Implementation of a public method foo bar, returning a void 
/// </summary> 
/// <param name="value">A string parameter named value input</param> 
public void fooBar(string valueInput) 
{ 

} 
#endregion 

¿Hay un enchufe en o característica de ReSharper para eliminar todos sus comentarios y #region tags a granel?

Respuesta

4

¿Por qué no utilizar el regex find & reemplazar en Visual Studio?

Para comentarios triples slash:

 ///.* 

Para las etiquetas región:

 [#]region.* 
    [#]endregion 
+0

Funciona perfectamente, gracias! – MatthewMartin

1

Estas piezas eran probablemente escrito a mano:

Implementación de un foo bar método público, volviendo un vacío

y

Un valor denominado parámetro de cadena de entrada

Si esto es en un proyecto de biblioteca de clases, no se desharía de los comentarios XML - que son lo que se mostrará en el intellisense indicaciones para esos artículos. Eliminarlos podría hacer que otros desarrolladores se enojen contigo; para todo el texto aquí no es muy bueno, las indicaciones predeterminadas son crípticas e incluso peores.

+0

Lo sé, los escribí a mano. No voy a publicar el código fuente real en SO. Soy el único desarrollador. Intellisense ya proporciona metadatos en métodos sin comentarios. – MatthewMartin

+0

De acuerdo en general, pero en este contexto no creo que los comentarios XML agreguen mucho. Realmente debería decir más sobre lo que está haciendo. –

1

Yo diría que reemplazarlos con algo más sensato es mucho mejor que despojarlos. Por más mundanos que puedan ser, no tener comentarios es siempre peor (a menos que los comentarios sean incorrectos, por supuesto) Entonces, ningún comentario es mejor) :-)

Dicho esto, creo que this does what you're looking for.

Para las etiquetas de región, puede intentar adaptar esa aplicación o usar VS 'regex find/replace.

1

Voto que entre y lo solucione a medida que se encuentre con ellos. He tenido que hacer lo mismo aquí ... cada vez que voy a una clase que tiene malos comentarios (en mi caso: ninguno). Comenta los métodos/propiedades mientras trabajo con ellos. Después de 3 semanas, he comentado correctamente sobre 1/2 de la base de código y he desarrollado una mejor comprensión de todo el proyecto.

Cuestiones relacionadas