Ein Beispiel, das mir in den Sinn kommt, ist, dass es möglich ist, einen %code% style-Kommentar versehentlich zu unterbrechen. Zum Beispiel
%Vor%Dieser Code wird nicht kompiliert, während die %code% Variante dies tun würde. Außerdem stellt %code% eine bestimmte Art von Dokumentation dar, auf die externe Tools unterschiedlich reagieren.
Eine Sache, die / * * / das tun kann // ist nicht, einen inneren Teil einer Zeile zu kommentieren. Ich werde das manchmal verwenden, um einen Parameter zu einer Methode zu kommentieren, bei der etwas nicht offensichtlich ist:
%Vor%In diesem Fall repräsentiert die Konstante 0.0, die als dritter Parameter übergeben wird, die Höhe. Natürlich könnte das besser sein:
%Vor%(Ich verwende eher die / * * / Intra-Line, um nur einen bestimmten Wert zu übergeben.)
%code% ist für mehrzeilige Codeblöcke in Ordnung. Zum Beispiel am Anfang einer Codedatei, Copyright-Informationen usw.
%code% ist einfacher für eine einzelne Zeile.
Verwenden Sie immer %code% für mindestens alle öffentlichen Member in einer Klasse, da Ihre XML-Dokumentation aus der generiert wird, aus der Sie Hilfedateien erstellen können.
Ich denke, Sie kommentieren, wie Sie möchten, da die meisten von uns über Verknüpfungen in Visual Studio kommentieren. Ich benutze %code% alle ausgewählten Zeilen sind comentred und %code% um ausgewählte Zeilen auszukommentieren.
Meine Meinung ist, dass "//" einfacher einzutippen ist als / ** /
Ich benutze immer // für tatsächliche COMMENTS, während ich das / * * / für Code speichere, den ich vorübergehend nicht für Debugging / Entwicklungszwecke ausführen möchte.
Wenn Sie nur // verwenden, können Sie sicher sein, dass Sie einen großen Block von Zeilen / Methoden usw. auskommentieren können, ohne Kommentare zu verschachteln und Ihren Compiler zum Weinen zu bringen.
Meine Vermutung ist, weil man in jeder Zeile eine explizite Syntax benötigt und man Kommentare erstellt, die große Codeabschnitte auskommentieren können, wenn das Closing %code% nicht verwendet wird. Es ist einfach nicht so sicher.
Es gibt einige Gründe, // zu bevorzugen zu / * .. * /.
Ich denke, %code% wird schließlich den Weg des Dodo gehen, weil Sie in Visual Studio einfach einen Block Code auswählen und STRG-E, C drücken können, um ihn mit dem %code% Stil zu kommentieren.
Ich würde nicht sagen, dass ich eine starke Meinung gegen beides habe - aber IMO ist das größte Problem, dass %code% und %code% unordentlich werden, wenn Sie es verschachtelt haben, mit dem Nebeneffekt, dass Sie nicht kopieren / einfügen können blockiert sicher (ganz).
Sie können zu leicht mit dem falschen Code kommentarisiert / aktiviert werden, oder es kann dazu kommen, dass es nicht kompiliert wird, weil Sie ein %code% gefunden haben.
Wenn Sie einen Block von %code% herum kopieren, ist das kein Schaden - nur diese Zeilen bleiben kommentiert.
Ich würde nicht sagen, dass ich eine starke Meinung gegen beides habe - aber IMO ist das größte Problem, dass /*
und */
unordentlich werden, wenn Sie es verschachtelt haben, mit dem Nebeneffekt, dass Sie nicht kopieren / einfügen können blockiert sicher (ganz).
Sie können zu leicht mit dem falschen Code kommentarisiert / aktiviert werden, oder es kann dazu kommen, dass es nicht kompiliert wird, weil Sie ein /* /* */ */
gefunden haben.
Wenn Sie einen Block von //
herum kopieren, ist das kein Schaden - nur diese Zeilen bleiben kommentiert.
Ein Beispiel, das mir in den Sinn kommt, ist, dass es möglich ist, einen /*
style-Kommentar versehentlich zu unterbrechen. Zum Beispiel
Dieser Code wird nicht kompiliert, während die //
Variante dies tun würde. Außerdem stellt ///
eine bestimmte Art von Dokumentation dar, auf die externe Tools unterschiedlich reagieren.
Es gibt einige Gründe, // zu bevorzugen zu / * .. * /.
Eine Sache, die / * * / das tun kann // ist nicht, einen inneren Teil einer Zeile zu kommentieren. Ich werde das manchmal verwenden, um einen Parameter zu einer Methode zu kommentieren, bei der etwas nicht offensichtlich ist:
%Vor%In diesem Fall repräsentiert die Konstante 0.0, die als dritter Parameter übergeben wird, die Höhe. Natürlich könnte das besser sein:
%Vor%(Ich verwende eher die / * * / Intra-Line, um nur einen bestimmten Wert zu übergeben.)
/* */
ist für mehrzeilige Codeblöcke in Ordnung. Zum Beispiel am Anfang einer Codedatei, Copyright-Informationen usw.
//
ist einfacher für eine einzelne Zeile.
Verwenden Sie immer ///
für mindestens alle öffentlichen Member in einer Klasse, da Ihre XML-Dokumentation aus der generiert wird, aus der Sie Hilfedateien erstellen können.
Ich denke, Sie kommentieren, wie Sie möchten, da die meisten von uns über Verknüpfungen in Visual Studio kommentieren.
Ich benutze ctr+K, ctrl+C
alle ausgewählten Zeilen sind comentred und ctr+K ctrl+U
um ausgewählte Zeilen auszukommentieren.
Meine Meinung ist, dass "//" einfacher einzutippen ist als / ** /
Ich denke, /* */
wird schließlich den Weg des Dodo gehen, weil Sie in Visual Studio einfach einen Block Code auswählen und STRG-E, C drücken können, um ihn mit dem //
Stil zu kommentieren.
Ich benutze immer // für tatsächliche COMMENTS, während ich das / * * / für Code speichere, den ich vorübergehend nicht für Debugging / Entwicklungszwecke ausführen möchte.
Wenn Sie nur // verwenden, können Sie sicher sein, dass Sie einen großen Block von Zeilen / Methoden usw. auskommentieren können, ohne Kommentare zu verschachteln und Ihren Compiler zum Weinen zu bringen.
Meine Vermutung ist, weil man in jeder Zeile eine explizite Syntax benötigt und man Kommentare erstellt, die große Codeabschnitte auskommentieren können, wenn das Closing */
nicht verwendet wird. Es ist einfach nicht so sicher.
Tags und Links c#