C # Kommentare Tutorial [geschlossen]

8

Ich würde gerne wissen, welches das beste Material ist, das ich meinen Schülern über " C # Kommentare " aushändigen kann.

    
Germstorm 21.11.2008, 13:28
quelle

4 Antworten

2

Das ist ziemlich interessant mit den XML-Kommentaren zu tun: Ссылка

Diese werden von sandcastle auch gelesen ...: o)

    
NikolaiDante 21.11.2008, 14:02
quelle
12
Dieser Beitrag von Jeff Atwood auf seinem Blog Coding Horror geht allgemein auf den Zweck von Kommentaren ein. Etwas, von dem du denkst, dass es 'duh' ist, ist es wirklich nicht - besonders in der 'realen Welt', wenn du Kommentare wie die folgende siehst:

%Vor%

Und natürlich gibt es die logische Folge dieses Posts: Codierung ohne Kommentare .

    
George Stocker 21.11.2008 13:35
quelle
12

Etwas, das ich vor einer Weile gelesen habe (und wo ich den Überblick verloren habe) ist:

  • Anfänger kommentieren nichts
  • Lehrlinge kommentieren das Offensichtliche
  • Gesellen kommentieren den Grund dafür
  • Masters kommentieren den Grund dafür, es nicht anders zu machen
Peter M 21.11.2008 14:28
quelle
2

In VS

Kommentare sind relativ einfach.

Sie können für einzelne Zeile verwenden:

%Vor%

Sie können für mehrere Zeilen verwenden :

%Vor%

Für Methode können Sie Folgendes verwenden:

%Vor%

Außerhalb VS

Wenn Sie in die Projekteigenschaft wechseln, können Sie alle Kommentare in XML ausgeben und bearbeiten.

Gute Praxis

Kommentare sollten nicht verwendet werden, um zu beschreiben, WAS der Code tut, sondern WARUM oder WIE, wenn es nicht klar ist.

    
Patrick Desjardins 21.11.2008 13:32
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Was ist der beste Weg, SQL Server über die Befehlszeile zu starten und zu stoppen?