Thomas Bandt

Über mich | Kontakt | Archiv

Automatische Code-Dokumentation mit .NET 2.0 und NDoc

Offiziell wird .NET 2.0 von NDoc noch nicht unterstützt, es gibt aber ein inoffizielles Release von Jonas Lagerblad: Einfach die Binaries runterladen, entpacken und NDocGui.exe starten (nicht vom Icon irritieren lassen). Damit lassen sich nun DLL's oder EXE-Files die unter 2.0 laufen, einbinden und dazu benutzen entsprechende Code-Dokumentationen aus den XML-Kommentaren zu erstellen.

Damit er die eigenen Kommentare auch mit benutzt, muss man natürlich vorher die Erstellung der XML-Files entsprechend aktivieren:

  1. Rechtsklick in Visual Studio auf das Projekt
  2. Properties
  3. Build
  4. Output: Haken bei "XML documentation file" aktivieren.

Wenn man das File gleich im Projekt-Output-Path erstellen lässt, so wie es Visual Studio vorschlägt, findet NDoc anschließend auch gleich das zur Exe oder DLL gehörende Dokumentations-File, und es gibt keine Probleme.

Danke an Albert für die Tipps.



« Zurück  |  Weiter »