C # Codierungsstil: Kommentare

8
___ answer1745198 ___

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.

    
___ answer1745426 ___

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.)

    
___ answer1745187 ___

%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.

    
___ answer1745188 ___

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.

    
___ qstnhdr ___ C # Codierungsstil: Kommentare ___ answer1745192 ___

Meine Meinung ist, dass "//" einfacher einzutippen ist als / ** /

    
___ answer1745213 ___

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.

    
___ answer1745189 ___

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.

    
___ tag123c ___ C # (sprich "Cis") ist eine objektorientierte Programmiersprache auf hohem Niveau, die zum Erstellen einer Vielzahl von Anwendungen entwickelt wurde, die auf dem .NET Framework (oder .NET Core) ausgeführt werden. C # ist einfach, leistungsfähig, typsicher und objektorientiert. ___ answer1745220 ___

Es gibt einige Gründe, // zu bevorzugen zu / * .. * /.

  • Wie JaredPar erwähnt hat, gibt es seltsame Probleme bei der Verschachtelung von Kommentaren, die mit / * * / usage auftreten können.
  • Wenn Sie jemals einen Code geschrieben / geschrieben haben, der Quellcode-Dateien verarbeitet, werden Sie wirklich glücklich sein, wenn Sie nur mit der // -Methode umgehen können.
  • Es ist viel einfacher, einen großen Block von kommentiertem Code mit der Methode "//" visuell zu erkennen, insbesondere wenn die Syntaxfarbe nicht verfügbar ist. Tatsächlich sehen Sie die einzelnen Zeilen oft in einem / * * / Block mit dem Präfix *, um sicher zu sein.
  • Der XML-Kommentarstil, der zum Erstellen von Codedokumentation verwendet werden kann, erfordert die Verwendung von "///".
___ answer1745209 ___

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.

    
___ answer1745191 ___

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.

    
___
nw. 16.11.2009, 22:12
quelle

10 Antworten

9

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.

    
Marc Gravell 16.11.2009, 22:14
quelle
6

Ein Beispiel, das mir in den Sinn kommt, ist, dass es möglich ist, einen /* style-Kommentar versehentlich zu unterbrechen. Zum Beispiel

%Vor%

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.

    
JaredPar 16.11.2009 22:15
quelle
6

Es gibt einige Gründe, // zu bevorzugen zu / * .. * /.

  • Wie JaredPar erwähnt hat, gibt es seltsame Probleme bei der Verschachtelung von Kommentaren, die mit / * * / usage auftreten können.
  • Wenn Sie jemals einen Code geschrieben / geschrieben haben, der Quellcode-Dateien verarbeitet, werden Sie wirklich glücklich sein, wenn Sie nur mit der // -Methode umgehen können.
  • Es ist viel einfacher, einen großen Block von kommentiertem Code mit der Methode "//" visuell zu erkennen, insbesondere wenn die Syntaxfarbe nicht verfügbar ist. Tatsächlich sehen Sie die einzelnen Zeilen oft in einem / * * / Block mit dem Präfix *, um sicher zu sein.
  • Der XML-Kommentarstil, der zum Erstellen von Codedokumentation verwendet werden kann, erfordert die Verwendung von "///".
John Fisher 16.11.2009 22:19
quelle
4

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.)

    
crpatton 16.11.2009 23:01
quelle
3

/* */ 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.

    
Wim Hollebrandse 16.11.2009 22:14
quelle
1

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.

    
Eugeniu Torica 16.11.2009 22:14
quelle
1

Meine Meinung ist, dass "//" einfacher einzutippen ist als / ** /

    
Kristina Brooks 16.11.2009 22:14
quelle
1

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.

    
Philip Wallace 16.11.2009 22:17
quelle
1

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.

    
Erik Kerber 16.11.2009 22:18
quelle
0

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.

    
Andrew Flanagan 16.11.2009 22:14
quelle

Tags und Links