Inhalt/Aufbau der Quellcodedokumentation?!

[Czemel]

Moin Moin...

Kann mir jemand dein Aufbau einer Quellecodedoku. beispielhaft beschreiben?!

Ich bin mir nicht sicher was ich dort genau formulieren soll?! oder einfach nur den Quellcode Copy&Past rein?!

Gruß

Czemel

[allesweg]

:confused:

Was willst du? Den Quelltext kommentieren oder ein extra Dokument erstellen? Die Dokumentation des Abschlussprojektes ist keine Quelltextdokumentation.

[Czemel]

Ein extra Dokument sollte es ein.

Vielleicht noch zur Info... Die IHK Düsseldorf ist für mich zuständig...

Gruß

Czemel

[Knoppers]

Moin Moin,

ich habe damals eine Moduldokumentation erstellt. Im Grunde habe ich einzelne Pakete meiner Software und die darin enthaltenen Methoden beschrieben. Hier hab ich mich aber auch nur auf die wichtigen Infos wie z. B. was macht die Methode im fachlichen Kontext, und technisch die Schnittstellen (Übergabeparameter, Rückgabewert) zu anderen Paketen/Modulen beschrieben.

Einzelne Code-Zeilen würd ich nicht erklären, eher verweis auf die Inline-Doku

Gruß,

Knoppers

[Czemel]

Okay, Danke.

Werde nur die wichtigsten Funktionen, z.B. die Benutzerrechteprüfung mit einem kurzen Fließtext einleiten und auf die Inline-Doku. verweisen.

Gruß

Czemel

[M.A.Knapp]

Quellcodedokumentation steht ansich im Quellcode selbst und zusätzlich doku in einem für javadoc oder doxygen parsbarem Format