Software-Dokumentation

Question

Hallo zusammen,

kann mir jemand Tipps geben wie man eine Softwaredokumentation erstellt, und evtl. ob es Hilfsmittel dazu gibt?

Gruss Peter

Answer 1

Hallo Peter,

das hängt davon ab, was genau Du dokumentieren willst.

Gängige Praxis ist es, XML Kommentare zu schreiben, über die man dann über Tools wie SandCastle eine Dokumentation generieren kann, die ähnlich wie die MSDN Dokumentation aufgebaut ist; siehe Documenting Your Code with XML (Visual Basic), diese Kommentare werden auch entsprechend im Objektkatalog und von IntelliSense in Visual Studio angezeigt.

---

Olaf Helper

[ Blog] [ Xing] [ MVP]

Answer 2

Hallo Olaf,

Danke für deine Antwort.

Es geht darum Aufbau und Funktionsweise des Programms zu Dokumentieren.
Da ich das noch nie gemacht habe, stehe ich da etwas im dunkeln, bez. Form und Inhalt.

Gruss Peter

Answer 3

Hallo Peter,

am einfachsten ist wirklich den SandCastle zu verwenden. Hier wird das auch nochmal schön erklärt wie man die Installation vornimmt und was man beim Coden beachten muss.

Answer 4

Hallo Peter,

wenn Du bisher keine Xml-Kommentare in Deinem Programm hast, schau Dir mal die GhostDoc Erweiterung an. Das erleichtert es, eine Basis zu schaffen, mit der dann Sandcastle und Co. was anfangen können.

Wobei die Frage wäre: Soll es eine Dokumentation für den Programm Code selbst sein, oder doch eher eine Software-Dokumentation für Anwender bzw. Käufer des Programms?

Gruß Elmar

Answer 5

Hallo Divid

vielen Dank für deine Info.

Gruss Peter

Answer 6

Hallo Elmar,

ich schaue mir die Erweiterung an!
Kommentare zu Klassen und Funktionen mittels ''' habe ich zu einem grossen Teil aufgenommen.

Es soll eher eine Dokumentation für den Programm Code sein, sodass andere den Code erweitern können und darin durchblicken können.

Dank und Gruss
Peter