Hi,
durch das ein oder andere Scripting Projekt und dessen Dokumentation bin ich neulich über das Tool "Sandcastle" gestolpert. Dieses ist in der Lage aus Code-Kommentaren einer dll-Datei, Hilfe-Dateien für eben diese zu erzeugen.
Nicht jeder verfügt über das Modul "API-Extension", mit der auch die API-Doku ausgeliefert wird. Jedoch können die Infos aus der Doku für den einen oder anderen Script-Bastler hilfreich sein. Deshalb habe ich hier mal eine zwar englische aber recht einfach zu folgende Anleitung zum Doku-selber-bauen rausgesucht.
http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html
Nicht erschrecken! Wir brauchen nur Step 1, Step 4 und den Anfang von 5.
Anstelle der in der Anleitung erzeugten Guy.dll + Guy.xml, binden wir die folgenden Dateien aus dem "..\EPLAN\Platform\[version]\Bin" Ordner ein:
Eplan.EplApi.AFu.dll
Eplan.EplApi.AFu.xml
Eplan.EplApi.Baseu.dll
Eplan.EplApi.Baseu.xml
Eplan.EplApi.DataModelu.dll
Eplan.EplApi.DataModelu.xml
Eplan.EplApi.EServicesu.dll
Eplan.EplApi.EServicesu.xml
Eplan.EplApi.Guiu.dll
Eplan.EplApi.Guiu.xml
Eplan.EplApi.HEServicesu.dll
Eplan.EplApi.HEServicesu.xml
Eplan.EplApi.MasterData.dll
Eplan.EplApi.Ppeu.dll
Eplan.EplApi.Ppeu.xml
Eplan.EplApi.Systemu.dll
Eplan.EplApi.Systemu.xml
In den Project Properties (Taste F4) kann man noch ein paar Einstellungen wie den Ausgabepfad, Format, Titel, Name etc. vornehmen.
Die Durchlaufzeit des Build-Prozesses kann je nach Rechnerleistung relativ hoch sein (Intel Core2, 2,4GHz ca. 50min).
Es werden auch Tausende Warnungen wegen fehlender Referenzen ausgegeben. Diesen bin ich nicht weiter nachgegangen. Das Ergebnis ist dennoch brauchbar.
Der User, und Migration Guide aus der Originaldoku fehlen. Der Rest scheint sehr ähnlich zu sein.
Man könnte so auch eigene Doku anfügen, oder sich nur die für das Scripting relevanten Bibliotheken (*.AFu.*; *.Baseu.*; *.Guiu.*) erzeugen.
Anbei noch ein Screenshot mit vergleich Original zu "Selbstgemacht".
Viel Spaß!
MfG Daniel
------------------
“Hacker (noun): An organism that converts caffeine or alcohol into code.”
~ Standard Definition
YouTube
GitHub
DokuWiki
Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP