Wie Quellcode dokumentieren?

[kahuna]

Hallo,

Das mein dein Compiler:

/// <summary>
/// Aufzählungsbezeichner für die unterschiedlichen Clienttypen
/// </summary>
/// <value>TCP</value>
/// <value>UDP</value>
public enum ClientType {
/// <summary>
/// Summary for TCP
/// </summary>
TCP,
/// <summary>
/// Summary for UDP/// </summary>
UDP,
/// <summary>
/// Summary for HTTP
/// </summary>
HTTP,
/// <summary>
/// Summary for HTTPS
/// </summary>
HTTPS
};

Gruss Alexander

 

[MD1978]

danke.
noch eine Frage:
Wie kann ich in VisualStudio eine Klasse innerhalb eines Projektes für die XML-Kommentare ausschließen?


MD

 

[Rando]

Obgleich ihr schon mitten im Thema seid, wollte ich doch noch der Vollständigkeit halber doxygen nicht unerwähnt lassen, weil es zwar initial für JAVA gedacht, doch auch für C# sehr gute Dienste leistet. Zugegebenermaßen ist die Anlage der Kommentare nicht unbedingt den Vorstellungen von Microsoft konform, aber im Ergebnis habe ich bisher kaum bessere KommentarPages gesehen.

Greeds Rando