[.NET] Code Dokumentation generieren

[Monger]

Hallo,

kann mir jemand Tipps geben, was für Möglichkeiten zur Generierung von Hilfe Dokumenten aus den Quellcodekommentaren heraus es in .NET gibt?

Visual Studio generiert selbst ja standardmäßig erstmal diese XML, die dann als Grundlage für den Objekt Browser und die Intellisense dient.

Ich weiß mittlerweile, dass man aus dieser XML heraus per SandCastle eine CHM Hilfe generieren kann. Per NDoc kann man auch eine lokale Online Hilfe generieren, die ich aber relativ aufwändig erst im Visual Studio registrieren muss.

Gibt es noch mehr Möglichkeiten? Der Installationsaufwand ist hier ein wichtiges Argument, weil mehrere Leute diese Hilfe nutzen würden, und diese wahrscheinlich recht häufig aktualisiert werden würde.
Ideal fände ich ja so eine Art Online Hilfe, die ich auf einem lokalen Webserver hier hosten könnte, und zu der man ähnlich wie zur MSDN per F1 aufs jeweilige Schlüsselwort kommt. Ist das möglich? Kennt sich hier jemand mit sowas aus?

[Gast]

Ich wüsste nicht was gegen Sandcastle bzw. Sandcastle Builder spricht. Das Erstellen ist ziemlich komfortabel, auch wenn es nicht ungedingt sehr performant ist. Damit kannst du doch eh schon eine html Hilfe generieren, zumindest habe ich das einmal geschafft. Ich weiß zwar jetzt spontan nicht mehr wie genau, aber es ist auf jeden Fall möglich.

In Visual Studio das Ganze einzubinden ist wahrscheinlich keine allzu gute Idee. Gut, man hat es gleich integriert, aber ein Browserfenster mehr oder weniger stört doch nicht wirklich, wenn der Webserver schnell genug ist und man nicht ewig warten muss und die Leute, die eine Bibliothek benutzen sollten sehr wohl den Unterschied zwischen den .NET internen Funktionen und den Funktionen der Bibliothek kennen.

[Monger]

Wenn ich direkt im Code drinstehe, möchte ich eigentlich nicht erst irgendwo die Hilfe rauskramen und daran von Hand nach der passenden Klasse suchen, sondern idealerweise drücke ich einfach F1, und bin genau da wo ich hinwollte.

Das geht z.B. mit NDoc. Da lässt sich eine MSDN-artige Hilfe generieren, die sich in gleicher Weise ins Visual Studio integriert. Problem dabei ist wie gesagt: da diese lokal installiert werden muss, müsste man bei jeder Änderung der Dokumentation eine neue Version auf allen Rechnern installieren.

Das gilt auch für eine Chm Hilfe, wenn auch die Verteilung dort etwas unproblematischer ist.

Edit: oder mal anders gefragt - wie kommt eigentlich Visual Studio an die eigene Online Hilfe heran? Irgendwoher muss ja die Information kommen, wo und nach was im Internet gesucht werden soll.