2009-06-05 5 views
5

Ich habe etwas Code, den ich unterhalte, der eine Menge von maschinengenerierten Kommentaren und maschinengenerierten Regionen hat. (Oder durch eine besonders verleitet Entwickler erstellt)Wie man Robo-Kommentare und # Region von C# abstreifen?

Dies sind Kommentare ausschließlich die Methode Metadaten und Raumausdehnungen von pascal verrohrten Namen wiederholen:

#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 

Gibt es einen Stecker in oder Merkmal Resharper für die Kommentare Strippen und # region tags in großen Mengen?

Antwort

4

Warum nicht die Regex Find & ersetzen in Visual Studio?

Für die dreifache slash Kommentare:

 ///.* 

Für Region tags:

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

Funktioniert perfekt, danke! – MatthewMartin

1

Diese Teile wurden wahrscheinlich von Hand getippt:

Implementierung eines öffentlichen foo bar Methode, Rückkehr eine Lücke

und

Ein String-Parameter namens Werteingang

Wenn dies in einer Klassenbibliothek Projekt ist, würde ich nicht loszuwerden, die XML-Kommentare erhalten - sie sind das, was in der Intellisense angezeigt wird fordert zur Eingabe dieser Elemente auf. Sie zu entfernen, könnte andere Entwickler sehr wütend machen. Für alle Texte hier ist nicht sehr gut, die Standardansagen sind kryptisch und noch schlimmer.

+0

Ich weiß, ich habe sie von Hand eingegeben. Ich werde keinen echten Quellcode auf SO veröffentlichen. Ich bin der einzige Entwickler. Intellisense stellt bereits Metadaten zu unkommentierten Methoden bereit. – MatthewMartin

+0

Stimmen Sie im Allgemeinen überein, aber in diesem Zusammenhang glaube ich nicht, dass die XML-Kommentare viel hinzufügen. Es sollte wirklich mehr darüber sagen, was es tut. –

1

Ich würde sagen, sie durch etwas sinnvolleres zu ersetzen, ist viel besser als sie zu entfernen. So banal wie sie sein mögen, ist es immer schlimmer, keine Kommentare zu haben (außer die Kommentare sind natürlich falsch? Dann sind keine Kommentare besser) :-)

Das sagte ich glaube this does what you're looking for.

Für Regions-Tags könnten Sie versuchen, diese App anzupassen oder VS 'regex find/replace zu verwenden.

1

Ich stimme, dass Sie gehen und reparieren sie, wie Sie auf sie stoßen. Ich musste das gleiche hier tun ... jedes Mal, wenn ich in eine Klasse gehe, die schlechte Kommentare hat (in meinem Fall: keine). Ich kommentiere die Methoden/Eigenschaften, während ich mit ihnen arbeite. Nach 3 Wochen habe ich ungefähr 1/2 der Codebasis kommentiert und ein besseres Verständnis für das gesamte Projekt entwickelt.

Verwandte Themen