Welche Code Dokumentation ist denkbar bzw. sinnvoll?

05/02/2008 - 13:50 von Thomas Eisenmann | Report spam
Hallo alle miteinander,

ich bin dabei ein Projekt mit VB 2005 zu programmieren, bzw. bin ich noch in
der Planungsphase. So mache ich mir jetzt schon Gedanken über die
Dokumentation, bzw. Erlàuterung des Quellcodes. In der Dokumentation sollen
meinen Kollegen oder ich in der Zukunft nachschlagen können, wie der Code
funktioniert hat bzw. welchen Zweck die einzelnen "Bausteine" haben.

Dazu arbeite ich mit XML-Kommentare ('''), welche konsequent jeden
Software-Baustein beschreiben und dem Programmierer im Objektbrowser
angezeigt werden. In meinen bisherigen Projekten habe ich es dabei belassen.

Meine Fragen:

[1] Reicht das? Oder sollte ich die Dokumentation in ein anderes
Dokumentationsformate umwandeln? Durch die vorhandene XML-Datei, welche die
Kommentare enthàlt, hàtte ich eine gute Ausgangsposition, aber

[2] welches Zielformat ist denkbar bzw. sinnvoll? (.doc, online Hilfe,
offlline Hilfe o.à.)

[3] Hat VS 2005 schon Standard-Routinen zur automatischen Weiterverarbeitung
der Kommentare?

[4] Welche Freeware-Routinen sind hilfreich bzw. zu empfehlen?

[5] Welcher Vorteil bietet sich durch die Umwandlung der XML-Kommentare in
andere Dokumentationsformate überhaupt?

Ich danke euch im Voraus für euere Hinweise.

Grüße Thomas
 

Lesen sie die antworten

#1 Herfried K. Wagner [MVP]
05/02/2008 - 14:28 | Warnen spam
"Thomas Eisenmann" schrieb:
Dazu arbeite ich mit XML-Kommentare ('''), welche konsequent jeden
Software-Baustein beschreiben und dem Programmierer im Objektbrowser
angezeigt werden. In meinen bisherigen Projekten habe ich es dabei
belassen.

Meine Fragen:

[1] Reicht das? Oder sollte ich die Dokumentation in ein anderes
Dokumentationsformate umwandeln? Durch die vorhandene XML-Datei, welche
die
Kommentare enthàlt, hàtte ich eine gute Ausgangsposition, aber

[2] welches Zielformat ist denkbar bzw. sinnvoll? (.doc, online Hilfe,
offlline Hilfe o.à.)



Z.B. CHM.

[3] Hat VS 2005 schon Standard-Routinen zur automatischen
Weiterverarbeitung
der Kommentare?



Stichwort Sandcastle (von Microsoft):

<URL:http://codeplex.com/Project/Project...castle>

[5] Welcher Vorteil bietet sich durch die Umwandlung der XML-Kommentare in
andere Dokumentationsformate überhaupt?



Bessere Benutzbarkeit.

M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://dotnet.mvps.org/dotnet/faqs/>

Ähnliche fragen