Xml-Softwaredokumentation mit Visual Studio erstellen
Hallo!
Gibt es eine Funktion in Visual Studio um aus Kommentaren (siehe Beispiel) eine Software-Dokumentation zu erstellen (xml-Datei)?
Bsp.:
/// <summary>
///
/// </summary>
/// <param name="args"></param>
Gruß
C-Sharpler9019
Hallo,
unter den Projekteigenschaften | Erstellen (od. Build) die Checkbox "XML-Dokumentationsdatei" aktivieren. Dateiname braucht keiner eingetragen werdne. Somit wird beim Kompilieren eine XML-Datei erstellt.
Eine Hilfe kann zB mit Sandcastle erstellt werden.
mfG Gü
Stellt fachliche Fragen bitte im Forum, damit von den Antworten alle profitieren. Daher beantworte ich solche Fragen nicht per PM.
"Alle sagten, das geht nicht! Dann kam einer, der wusste das nicht - und hat's gemacht!"
wie gfoidl schon sagte, kannst du Sandcastle verwenden um aus der xml-Datei eine CHM-Hilfe oder eine HTML-Hilfe zu erstellen. Da dass aber relativ kompliziert ist, empfiehlt sich die OpenSource Software "Sandcastle Help File Builder" zu verwenden.
MfG TrripleX
Träume nicht dein Leben sondern lebe deinen Traum.
Viele Grüße, David Teck
Hallo C-Sharpler9019,
in diesem Zusammenhang vielleicht auch interessant: Mit GhostDoc kann man die Erstellung der Kommentare im Quellcode erleichtern.
herbivore
Danke für den Tipp mit GhostDoc, das macht das ganze kinderleicht 😉