2009-06-05 9 views
5

Ho un codice che sto mantenendo che ha una buona dose di commenti generati dal macchinario e regioni generate dalla macchina. (O creato da uno sviluppatore particolare fuorviato)Come rimuovere i commenti robo e #region da C#?

Questi sono i commenti che si ripetono esclusivamente il metodo di metadati e di spazio espansioni di nomi con carter 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 

c'è un plug-in o caratteristica del ReSharper per lo stripping i commenti e #region tag in blocco?

risposta

4

Perché non utilizzare la ricerca delle espressioni regolari & sostituire in Visual Studio?

Per commenti triple oblique:

 ///.* 

Per regione tags:

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

Funziona perfettamente, grazie! – MatthewMartin

1

Queste parti erano probabilmente tipizzate mano:

Implementazione di un bar foo metodo pubblico, di ritorno un vuoto

e

un valore denominato parametro di stringa di input

Se si tratta di un progetto libreria di classi, non avrei sbarazzarsi dei commenti XML - sono ciò che verrà visualizzato nel intellisense richiede quegli oggetti Rimuoverli potrebbe rendere gli altri sviluppatori molto arrabbiati con te; perché tutto il testo qui non è molto buono, i prompt predefiniti sono criptici e persino peggio.

+0

Lo so, li ho scritti a mano. Non pubblicherò il vero codice sorgente su SO. Sono l'unico sviluppatore. Intellisense fornisce già meta-dati su metodi non commentati. – MatthewMartin

+0

D'accordo in generale, ma in questo contesto non penso che i commenti XML stiano aggiungendo molto. Dovrebbe davvero dire di più su cosa sta facendo. –

1

Direi che sostituirli con qualcosa di più sensato è molto meglio che toglierli. Per quanto banali possano essere, non avere commenti è sempre peggio (a meno che i commenti non siano corretti, ovviamente?) Nessun commento è sicuramente migliore) :-)

Detto questo, credo sia this does what you're looking for.

Per i tag di regione, è possibile provare ad adattare l'app o utilizzare la ricerca/sostituzione di espressioni regolari di VS.

1

Io voto che entri e li correggi quando li incontri. Ho dovuto fare la stessa cosa qui ... ogni volta che vado in una classe che ha commenti negativi (nel mio caso: nessuno). Io commento i metodi/proprietà mentre lavoro con loro. Dopo 3 settimane, ho commentato correttamente circa il codice base e ho sviluppato una comprensione più forte dell'intero progetto.