✔ HTML Doku aus Kommentaren erstellen

[mschlegel]

Hi

Also entweder bin ich blind oder MS is doof ;-)

Ich würder gerne aus meinen Methodenkommentaren eine ordentlich lesbare HTML-Dokumentation erstellen.

/// <summary>
/// bla blubb.
/// </summary>
/// <returns>foobar</returns>
public static List<Stream> LoadAllReports()

Ich nutze hier VS 2005 (da es sich um ein Business-Intelligence Projekt handelt), 2008 ist aber auch installiert. Sämtliche Anleitungen die ich finde (z.B. hier und hier) sagen mir wie ich das direkt aus VS machen kann, aber ich finde keines der genannten Menüs.

Meine Frage ist jetzt, bin ich einfach blind oder fehlt da wirklich etwas?

 

[engelmarkus]

Also anscheinend gibts diesen Menüpunkt nur in Visual Studio .Net (=2003). Ich hab den nämlich auch nicht.

 

[mschlegel]

Also manchmal kapier ich MS wirklich nicht.

VS ist ein wirklich mächtiges Tool, auch wenn es andere gibt die mir persöhnlich besser gefallen, aber wie kann man so etwas selbstverständliches weglassen...ich hab keine Lust mir erst irgendein XSD zu basteln um eine Doku zu erhalten (wenn ich mal die Funktion für die Erstellung des xmls gefunden habe).

 

[Nico Graichen]

Brauchst du auch nicht.
In den Projekteigenschaften kannst du angeben, ob und wohin das Xml-File generiert werden soll.
Mit Hilfe von Sandcastle (der Nachfolger des Doku-Generators aus VS 2003) kannst du dann eine Html-Doku generieren.

 

[Norbert Eder]

Zu Sandcastle gibt es dann auch noch den Sandcastle Help File Builder, der die Verwendung erheblich einfacher macht.

 

[mschlegel]

Jo, den hatte ich dann auch noch gefunden.

Trotzdem mehr als schade dass es nicht direkt in Visual Studio integriert ist, zumal dieses ja doch ein stattliches Sümmchen kostet.

Danke für eure Hilfe

 

[Nico Graichen]

Jo, den hatte ich dann auch noch gefunden.

Trotzdem mehr als schade dass es nicht direkt in Visual Studio integriert ist, zumal dieses ja doch ein stattliches Sümmchen kostet.

Danke für eure Hilfe

Es ist nach VS 2003 rausgeflogen, weil die alte Version fehlerhaft war. Und Sandcastle war mit 2005 noch nicht fertig.
Außerdem seh ich kein Problem darin, dass es nicht in der IDE ist.
So hast du den Vorteil einen Generator zu nutzen, den du bevorzugst. Das Generieren funktioniert nämlich auch eingeschränkt mit Doxygen oder NDoc

 

[Norbert Eder]

Es hat schon seinen Grund, warum das nicht im Visual Studio inkludiert ist. Beispielsweise Nightly/Weekly Builds, welche nicht nur die Solution kompilieren, Unit Tests dagegen ausführen, sondern auch die Doku neu generieren.