Dokumentieren von Source Code

Computer: Software & Programmierung Programmierung allgemein
#1

Hallo
ich suche schon ziemlich lange nach Kriterien bei der Dokumentation von Source Code und zur Erstellung von einer Technische Doku b.z.w. einer Benutzer Doku.
Weiß vielleicht einer von euch wo man so was finden kann…

(Es geht um Fragen wie was wird dokumentiert ? Wie tief ? Wo wird Dokumentiert? z.B. C++ im h oder m file.)

Sonja

#2

Hallo Sonja,

ich hab zwar keine Doku für sowas, aber ich mußte mal für ein Schulprojekt eine Doku erstellen (Projekt war übrigens 1+ :smile: )

Zur Source Doku:

  • erklären wofür alle Variablen da sind (nur Header)
  • Die Methoden und deren Sinn erklären (auch wenn es ab und zu sehr trivial ist) (nur Header)
  • In den Methoden selbst wichtige, beeinduckende oder schwer zu verstehende Zeilen erklären.

Eine User-Doku (hier gibt es viele Möglichkeiten):

  • wofür ist das Proggie überhaupt da
  • Die GUI und deren Bnutzung (!!!)
  • spezielle Dinge, wie z.B. eine Spielstrategie, technische Details …

Zwar sind das wenige Punkte, aber du wirst schnell feststellen, dass vieles sehr ausarten kann.

Gruß Thomas

[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]

#3

Hi!

Auf dieser Seite findest Du Anforderungen an eine Dokumentation fuer eine praktische Pruefung.
http://www-ma2.rz.rwth-aachen.de/aushang/merkblatt.html
musst mal runter zur Haupt~ und Testdokumentation scrollen.

Vielleicht kannst Du damit was anfangen.
Gruss, tafp

#4

Hi Sonja,

ich glaube, das Thomas Herok die wesentlichen Dinge genannt hat.

Ich beschreibe mittlerweile den Sinn jeder Funktion verbal in ein paar Zeilen, denn nach einem halben Jahr weißt Du nämlich nicht mehr genau warum Du diese Funktion überhaupt geschrieben hast, oder warum Du diese Funktion auf diese Weise kodiert hast und nicht z.B. so, wie Du es sonst tust …

Außerdem führe ich alle Funktion auf, die in diese Funktion einspringen (sehr wichtig, wenn Du mal was ändern willst),

Manfred

[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]

#5

…

Außerdem führe ich alle Funktion auf, die in diese Funktion
einspringen (sehr wichtig, wenn Du mal was ändern willst),

…

hi, manfred,…
…grundsaetzlich hast du mit der angabe natuerlich schonm recht.
aber diese arbeit, die dir (neue) fehler (bei aenderungen bspw) einbringen kann, und deren zeitaufwand auch beachtlich ist, uebernimmt doch heutzutage das entwicklungs-tool.
einfacher und viel viel zuverlaessiger.
oder habe ich da was falsch verstanden?
gruss - digi

#6

hi, manfred,…
…grundsaetzlich hast du mit der angabe natuerlich schonm
recht.
aber diese arbeit, die dir (neue) fehler (bei aenderungen
bspw) einbringen kann, und deren zeitaufwand auch beachtlich
ist, uebernimmt doch heutzutage das entwicklungs-tool.
einfacher und viel viel zuverlaessiger.
oder habe ich da was falsch verstanden?
gruss - digi

Hi Dieter,

Der Aufwand ist gar nicht mal so groß.

Wie kann mir denn das Entwicklungstool hier Deiner Meinung nach helfen ?

Manfred

#7

bspw arbeite ich mit visual-studio m$.
da macht das alles das ide. automatisch stets up-to-date.
und per mouseklick sofort vorwaerts und rueckwaerts
erreichbar. einschliesslich map.
fuer ne schriftliche dokumentation ist das natuerlich nichts,
aber es ist WEITAUS BESSER als jede schriftform, und
natuerlich jederzeit fehlerfrei.
kann ich sonst noch was (genaueres) fuer dich tun? :smile:
gruss - digi

[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]