Ein kleiner Documentor

Hi folks 🙂

Ich brauchte für eine Dokumentation einiger Klassen ein Tool, welches diese aus dem Quelltext erstellt.
Nun war mir der Aufwand zu groß um mich mit nDoc, Sandcastle & Co auseinander zu setzten, da ich nur ein kleines Tool brauchte, das mir aus den Dateien die Methoden anzeigt.

Also hab ich mir so ein ding mal selbst gebastelt.
Und da vielleicht der ein oder andere auch etwas damit anfangen kann - man weiss ja nie, stelle ich euch das ding einfach mal zur verfügung.

Das geht jetzt ein Verzeichnis (Source-Verzeichnis mit *.cs Dateien) rekursiv durch, parst die Dateien und bastelt daraus ein paar HTML-Seiten.

Ein Beispiel ist dort zu finden: http://cheeezbuerger.de/testdoku/docu.html

Entschuldigt bitte den Frickelcode und die beschränkte Flexibilität der HTML Templates... aber... ist schon spät 😉

Sieht nett aus 🙂

Was noch praktisch wäre, das wenn auf die funktion clickt, diese dann den ganzen Quelltext der funktion zeigt.

Verdammt guter Ansatz.
Ausbaubar.

Oh - Danke euch beiden für das Lob 🙂

Ihr könnt ja gern ein paar sachen zusammen tragen - bitte gleich mit Lösungsansatz - allein denken fällt immer schwerer 😉

Vielleicht findet sich ja noch der ein oder andere der daran was ändern möchte - dann bin ich auch gern dazu bereit das in einem öffentlichen SVN-Repo bzw Trac zu stellen.

Leider hat das Programm für mich persönlich weniger Priorität, da ich es wie eingangs schon erwöhnt nur zum Dokumentieren einiger Methoden im Quellcode brauchte - weshalb ich da aktuell nicht wirklich interessiert bin noch mehr Arbeit als nötig rein zu stecken.

Aber wie gesagt - wenn jmd. von euch etwas dran ändern möchte - ich helfe gern 🙂

Ich würde nicht die .cs - Dateien parsen, sondern den XML-Austoss, der bei Bedarf erzeugt wird(Projecteigenschaften), parst sich auch leichter.
Das mit der Prio versteh gut.

mhm...
In der XML-Ausgabe stehen die Dateien nicht drin in der die Methoden zu finden sind.
Weiss ned - vielleicht ist es auch flexibler die *.cs files zu durchsuchen.

Mhm.. 😉
Der XmlAusstoss wird beim Compilieren erzeugt...

Naja wenn das beim kompilieren erzeugt wird, dauert das bei großn Projekten und lahmen PCs ewig.