Hallo zusammen

Ich entwickle ein Programm für unsere Firma, welches die internen Produktionsprozesse optimiert und steuert.
Die Programmstrukturen, Interfaces und Prozessabläufe haben bis jetzt eine stattliche Grösse erreicht.
Nun muss ich die Logik im Quellcode zu den einzelnen Verarbeitungsschritten dokumentieren, damit die "Nachwelt" ein Nachschlagewerk zu den einzelnen Methoden, Funktionen, Prozesse etc. zur Verfügung hat.

Bis jetzt brauche ich für die Dokumentationen die DB-internen Diagramme, Visio aus der Microsoftkollektion und natürlich tausende Quellcodeinfozeilen des Programmes mit entsprechenden Verweisen.

Hat jemand Erfahrung mit Quellcodedokumentationen und hat mir einen Tip, wie ich das anpacken kann?

Hallo mats74,

für reine Managed Projekte (C#, VB.NET) bietet sich SandCastle an. Diese erzeugt Dokumentationen im MSDN-Stil.
Um jedoch auch die einzelnen Codeblöcke zu dokumentieren, müßtest du dann per XML-Kommentare deinen Sourcecode erweitern (ich bin mir nicht sicher, ob SandCastle auch Inline-Kommentare verarbeiten kann).
Bei uns wird SandCastle hauptsächlich zur Dokumentation der externen API eingesetzt (ich selber habe damit bisher aber auch noch nicht konkret gearbeitet, sondern war bisher nur "Reviewer" der Doku).

P.S. Falls du dich dafür entscheiden solltest, darfst du mir gerne Feedback geben, da das im nächsten Jahr auch auf mich zukommt

Hallo Th69

Vielen Dank für Deine Stellungnahme.
Zu SandCastle habe ich in anderen Forums schon gute Feedbacks gelesen.
Es scheint mir, dass dies ein guter Weg zu einer "brauchbaren" Quellcodedokumentation sein könnte.
(Nun muss ich wohl noch mein Chef davon überzeugen )

Ich werde mich auf jedenfall bei Dir melden, wenn wir dieses Produkt getestet und im Einsatz haben.

Im Clientbereich benutzen wir für die Programmdokumentation den HTML Help Workshop von Microsoft.
Dieses Programm erfüllt in diesem Bereich seinen Zweck zufriedenstellend, für eine Quellcodedokumentation meiner Meinung nach aber unbrauchbar.

Hallo mats,

ja, überzeuge deinen Chef mal

Und den "HTML Help Workshop" benutze ich auch nur zur Erzeugung der Hilfe für den Anwender (d.h. F1).

Hallo Th69

Wir haben unsere Rechner auf Windows 7 Professional 64Bit aufgesetzt (.Net 4.0).
SandCastle bietet anhand der Webseite aber nur bis Windows Vista an.

Zitat:

Supported Operating Systems: Windows Server 2003; Windows Vista; Windows XP Service Pack 2 Required Software .NET Framework 2.0, which is available on the .NET Framework Downloads Web site. HTML Help Workshop for HTML Help 1.x files, which is available on the HTML Help Downloads Web site or by installing the Visual Studio SDK.

Habt ihr dieses Tool schon mal auf Windows 7 (.Net 4.0) erfolgreich installiert?
Vielleicht habe ich da eine Version verpasst.

Hallo mats74,

also ich habe es letzten Freitag bei mir unter Win7 (wenn auch 32-bit) erfolgreich installiert (ich denke, die Doku ist einfach nicht aktualisiert, denn wenn es für Vista läuft, dann auch für Win7).
Es kann jedoch sein, daß .NET 2.0 immer noch verwendet wird (d.h. installiert sein muß), aber sollte ja auch standardmäßig bei Win7 vorhanden sein.

Du solltest auch den SandCastle Help File Builder installieren, da dieser noch einige Patches, Features etc. nachinstalliert (als Wizard, d.h. nur per User-Interaktion).

Hallo Th69

... dazu muss dann noch die richtige Version von Visual Studio SDK installiert sein und somit funktioniert alles wie gewünscht.
Somit haben wir doch ein sehr gutes Tool für komplexere Quellcodedokumentationen zusammengebracht.

Vielen Dank für Deine Tipps.

Ich versuche verzweifelt die vom Delphicompiler erzeugte XML-Dokumentation (die über Documentation Insight gefüllt wurde) in den hier beschriebenen Sandcastle Builder zu kriegen. Aber er mag das Format nicht, will immer eine Assembly (die ich bei Delphi natürlich nicht habe). Wie habt ihr das also hinbekommen?

Vermutlich keiner. Wie du an den Vorlieben der an der Diskussion beteiligten Personen siehst kommen alle aus der Visual Studio Ecke.