developers.toolstage.de

XML-Kommentare und NDoc sind eine schnelle und praktische Möglichkeit zur Erstellung einer System-Dokumentation. Allerdings ist der Prozess zum Erstellen einer Dokumentation mittels NDoc etwas umständlich. Erst müssen die XML-Kommentare geschrieben werden, dann muss das Projekt erstellt werden und anschließend mit NDoc die Dokumentation erstellt werden.

Mit Hilfe des CR_Documentor geht es auch schneller. Das Tool bietet eine Vorschau der späteren NDoc Dokumentation innerhalb von Visual Studio.

Der CR_Documentor ist ein Plugin für DXCore, d.h. DXCore muss zuerst installiert werden. Eine kostenlose Version, die für private Projekte verwendet werden darf, findet sich hier. Nach der Installation muss nur noch die CR_Documentor .dll in das Verzeichnis C:\Programme\Developer Express Inc\DXCore for Visual Studio .NET\2.0\Bin\Plugins kopiert werden.

Der CR_Documentor wird aufgerufen über DevExpress > Tool Windows > Documentor. Klickt man nun mit der Maus in einen XML Kommentar, dann wird in dem Documentor Fenster eine Vorschau der Dokumentaion angezeigt.

Bookmarken bei...