Wie Quellcode dokumentieren?

[MD1978]

Hallo,
ich habe bisher vor allem mit Java entwickelt und javadoc zum Dokumentieren benutzt. Wie dokumentiere ich am besten C# Quellcode?


Gruss,

MD

 

[Christian Kusmanow]

In c# wird mit XML Documentiert.
3 Slashes (///) über einem Objekt eingegeben versehen es automatisch mit einem Summary-Tag.
Öffnest Du darunter einen neuen Knoten ( < ) werden Dir sofort weitere Dokumentiermöglichkeiten angeboten.
Dies ist aber bestantteil des VS (IntelliSense).
Hab jetzt keine Ahnung ob es jetzt auch bei anderen IDE's wie Eclypse funktioniert.
In der MSDN solltest Du eigentlich was finden.
In den Projekeigenschaften( VS ) kannst Du deine XML-Kommentardatei auch separat ausgeben lassen. Somit kannst Du die Dokumentation weiterreichen wenn Du z.B. eine DLL geschrieben hast.
Hab noch einen [thread=144538]Thread[/thread] dazu gefunden.

MfG cosmo

 

[MD1978]

danke!

ich benutze folgende XML Tags:
http://msdn.microsoft.com/library/d.../csref/html/vcwlkxmldocumentationtutorial.asp

Wenn ich aber dann über
"Extras" - "Erstellen von Kommentarwebseiten" die Dokumentation erstellen will, erhalte ich eine leere Seite.

Was mache ich da noch falsch?


Gruss,

MD

 

[kahuna]

Hallo

Lad dir NDoc herunter, der erstellt schöne Dokumentationen im MSDN, javadoc, etc Look.

Gruss Alexander

 

[MD1978]

gibt es noch andere Lösungen?
NDoc unterstützt leider nicht das Compact Framework.

MD

 

[Norbert Eder]

Hast du in den Projekteinstellungen auch die Pfade etc. korrekt eingetragen? Vielleihct solltest dir mal das Gespeicherte in diesen Pfaden genauer angucken, da es hier mit dem automatischen Öffnen des Browsers manchmal zu Problemen kommt.

Im Grunde funktioniert das Dokumentationstool vom VS sehr gut. Also ich hatte hier noch keine Probleme damit.

 

[MD1978]

Hallo,
mit dem NDoc funktioniert es jetzt doch sehr gut.
Nur ein paar spezielle Klassen des Compact Frameworks werden nicht unterstützt.

Danke für die ganzen Tips!

MD

 

[MD1978]

Eine kleine Frage habe ich aber noch:
Wie kommentiere ich bei einem enum Typ die einezlenen Werte?

Gruss,

MD

 

[Norbert Eder]

Du könntest es vielleicht mit mehreren Value-Tags tun. Sollte eigentlich den Zweck erfüllen.

 

[MD1978]

Hallo,
ich möchte folgendes kommentieren:

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


Mit dem Value-Tag funktioniert es nicht, weil ich in VS folgende Fehlermeldung erhalte:

XML-Kommentar für den sichtbaren Typ oder Member 'sendProcess.Client.ClientType.HTTP' fehlt.
XML-Kommentar für den sichtbaren Typ oder Member 'sendProcess.Client.ClientType.HTTPS' fehlt.
XML-Kommentar für den sichtbaren Typ oder Member 'sendProcess.Client.ClientType.TCP fehlt.
XML-Kommentar für den sichtbaren Typ oder Member 'sendProcess.Client.ClientType.UDP' fehlt.