Kommentar im Quellcode

[D-Power]

Hallo zusammen,

Ich bin dabei ein Programm für mein Abschlussprojekt in C++ zu schreiben. Dazu hab ich folgende Frage:

Wie stark wird Kommentar im Quellcode beurteilt? Denn den Quellcode werde ich schließlich auch der Dokumentation als Anhang beifügen. Ich habe mir gedacht, zu jeder Methode eine kurze Beschreibung der Methode, dessen Parameter und den Return-Wert zu schreiben. Muss ich mich dabei an irgend etwas halten? Normen, Regeln, Gebote?

[Ninni]

Ob es dazu Normen, Regeln oder Gesetze gibt, das weiss ich nicht.

Aber ich mache es so, das die Erklärung von einzelnen Methoden in die technische Dokumentation kommt. Den gesamten Quelltext gebe ich auch in den Anhang, aber da erkläre ich dann nichts mehr.

Gruß, Mugglberger

[P3AC3MAK3R]

Kann man umfangreich dokumentierten Quellcode nicht schon als technische Dokumentation bezeichnen?

[Crow T. Robot]

Hallo D-Power!

Gute Frage... Ich denke, "beurteilt" ist schon zu scharf gegriffen, aber das wird wohl von Prüfer zu Prüfer anders sein.

Bei der Kommentierung halte ich für besonders wichtig:

- Saubere Beschreibung der Schnittstellen, also wie du schon sagst, Aufgabe der Methode, ihrer Parameter und dem Rückgabewert.

- Bei lokalen Variablen bzw. Attributen deren Bedeutung.

- Eine Art "Vorwort" zu jeder Klasse über ihren Sinn und Zweck, ähnlich die bei den Aufgaben der Methoden.

- Kommentare zu Anweisungen sollten auch nicht erklären, was diese machen, sondern warum, damit ein Bezug zur einleitenden Beschreibung der Methode hergestellt wird.

Hoffe ich habe mich verständlich ausgedrückt, ich bin gerade am Einschlafen... :beagolisc

[MadCro]

Hi, bin auch dabei meine Doku für die Abschluss prüfung abzuschliessen

und habe so ein ähnliches Problem mit den Sourcen.

Also mein projekt ist mit/in :confused: Java entwickelt , so nun habe einen Anlage für die Doku die da heisst "Java Klassen und Methode" , da drine sind alle Klassen und methoden mit parametern und rückgabewerte beschreiben und erklärt.

Nun zur meiner Frage, muß da trozdem noch den gesamten Code des Programmes mit abgeben werde oder nur ausschnite des Programms (und welche da) oder gar kein Source Code mehr. hmmm ??:confused:

Was denkt Ihr ??

DAnke

gruß

MadCro

:marine