Frage

Ich bin mit C # und VB.NET.

ich oft (alle Tage ...) Hinzufügen von Kommentaren zu bestehenden Quelldateien. Wenn ich beim Check-in diesen Dateien Ich möchte meine Merge-Tool haben alle Änderungen an Kommentare zu ignorieren. - Ich will nur sicher sein, dass ich den Code nicht geändert hat

Ich benutze WinMerge und Team Foundation Control Server (ja, keine Chance: Subversion war keine Option, wenn ich diesen Job angenommen: o). Beide können Whitespaces ignorieren kann aber Kommentare nicht ignorieren. Ergebnis: Ich habe sorgfältig alle Änderungen suchen, die ich für jede Datei gemacht haben, bevor sie bei der Prüfung Und das ist ziemlich umständlich

..

(Nun, da die meisten meiner Kollegen gar nicht kommentieren - hey, verwenden sie ziemlich lange Namespace / Klasse / Methoden / Immobilien / Typ / constant Namen, die sie sagen alle, Jungs - es ist viel die Arbeit.)

Irgendwelche Vorschläge?

Alles Gute, Sylvain.

War es hilfreich?

Lösung

BeyondCompare einen Filter für das Ignorieren „unwichtig“ Änderungen und Kommentare gehören zu dieser Kategorie standardmäßig aktiviert.

Andere Tipps

Vergleich ++ hat eine Option „Ignorieren Kommentar Änderungen“ und „Ignorieren reine formatierten Änderungen“, die Ihren Antrag soll.

Sie sagen, Sie WinMerge verwendet - auch sie die Möglichkeit, Kommentare zum Ausfiltern haben

. Aber es funktioniert nur für Kommentare, die auf einer separaten Zeile sind, so zum Beispiel:

int i; // comment

wird von

als unterschiedlich erkannt werden
int i;

Es klingt wie Sie verwenden als ein Werkzeug zu kommentieren, den Code zu verstehen, wie Sie mit ihm arbeiten. Das ist eine interessante Idee, das Äquivalent von Hervorhebung eines Buches oder Notizen. Aber Sie müssen sicherstellen, dass Sie alle diese vorübergehenden Kommentare abzustreifen, bevor mit anderen.

Vor dem Vergleich oder die Förderung, führen Sie Ihre Quelldateien durch ein Filterprogramm, das die Kommentar-Streifen. Dies könnte ein Einzeiler Perl-Skript sein.

Um es einfacher, verwenden Sie ein unverwechselbares Muster für Ihre nicht-ständigen Kommentare, um sie leichter zu machen, um herauszufiltern (und zwischen diesen transienten Kommentaren zu unterscheiden und Kommentaren, die Sie wirklich wollen, um in der Quelle verlassen). Z.B. wenn Sie in C ++ geschrieben haben, immer einen Kommentar mit

 //Sylvain: this is my comment here.

oder ein anderes Muster, das noch leichter ist für grep.

Wenn der Inhalt der Kommentare sind nicht etwas, das Sie sich interessieren, und spielen keine Rolle, warum sie nicht löschen?

Wenn gut dokumentiert Code, lesbar und verständlich ist, ist Teil dessen, was Sie schaffen, warum Änderungen nicht auf diese Meta-Daten überprüfen?

Hinzufügen Kommentar zu Ihrem Code ist Geruch, den Code schwer zu lesen ist, sollte Code selbst beschreiben, wie jemand gesagt hat, dass guter Code wie guter Witz ist, braucht es nicht zu erklären. Es ist besser, Ihre Variablennamen zu ändern, Abschnitt Ihres Codes als eigenständige Funktion setzen. Re-Factoring ist besser als zu kommentieren. Auch finden Sie ein Werkzeug zu lösen Problem, das Sie zu kommentieren, ist es nicht das eigentliche Problem zu lösen, die Sie leicht zu verstehen ist, machen codieren.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top