Klassenbeschreibungen zum Code hinzufügen?

Question

Ich beende ein Projekt, an dem ich schon eine Weile gearbeitet habe und mache gerade den letzten Schliff.

Eine Sache, Ich mag würde Klassenbeschreibungen an der Spitze jeder Klasse tun, Datei hinzufügen ist (mir selbst zu helfen und andere Programmierer herauszufinden, was los ist). Mein Gedanke ist, nur ein paar '/' s zu benutzen, um eine Sektion abzuseilen, damit ich ein paar Notizen schreiben kann, aber vielleicht gibt es einen besseren Weg? Gibt es eine eingebaute Möglichkeit, dies in Visual Studio zu tun?

///////////////////////////////////////////////////// 
//             // 
// KillZombies.cs         // 
//             // 
// Description: This class contains blah blah blah // 
//             // 
///////////////////////////////////////////////////// 

Answer 1

Ja, Sie die normale XML documentation verwenden sollten:

/// <summary> 
/// Describe your class quickly here. 
/// </summary> 
/// <remarks> 
/// Add more details here. 
/// </remarks> 

diese Weise ist es in Intellisense angezeigt wird, und wenn Sie Ihre Dokumentation mit Sandburg/ndoc bauen/Doxygen usw. wird es angemessen erscheinen.

Wenn Sie „///“ in der Zeile über Ihre Klasse, sollten Sie eine entsprechende Vorlage sehen, um loszulegen. Weitere Informationen finden Sie oben im MSDN-Link.

Answer 2

Verwendung XML documentation comments:

/// <summary> 
/// This class performs an important function. 
/// </summary> 

Wenn Sie die drei Schrägstriche von Visual Studio Typ sind Sie mit dem Rest helfen.

Sie keine Lust ASCII-Formatierung verwenden, weil, wenn Sie Refactoring die Klassennamen zu ändern, die Sie im Alter von Neuformatierung alle Boxen verbringen werden, um sie wieder gut zu machen in einer Reihe aufstellen.

Answer 3

Die XML-Dokumentationskommentare in den Antworten oben beschrieben sind der Weg für die Dokumentation von Klassen und Methoden zu gehen.

Wenn Sie in jeder Datei zusätzliche Informationen zu nicht dokumentarischem Text benötigen, z. B. Erstellungsdatum, Credits, Urheberrechtsmeldungen usw., können Sie sie als Snippet hinzufügen oder der entsprechenden Visual Studio-Vorlage hinzufügen. VS hat spezielle Variablen für Vorlagen wie $ $ $ und $ Zeit Benutzernamen, die automatisch verwendet werden können, um diese Werte einfügen jedes Mal, wenn ein neues Element auf der Grundlage Ihrer Vorlage.