Quellcode Dokumentieren

[Der Martin]

Hallo,

Wie Dokumentiert und kommentiert man einen bestehenden fertigen Quellcode???

so, dass der Kommentar auf möglichst klare Weise erläutert, was der Sinn des Codes ist. ;-)
Also ich weiß nicht, wie "man" das am besten macht, ich kann dir nur sagen, wie ich es normalerweise mache.

wann ist es günstiger // zu verwendenn un wann /.../ in mehreren zeilen?

Das hängt zunächst mal von der Sprache ab. CSS kennt beispielsweise keine einzeiligen Kommentare mit //, Javascript oder C jedoch schon. Ich habe mir angewöhnt, in Sprachen, die einzeilige Kommentare mit // oder ähnlichem unterstützen (in Assembler oft das Semikolon), ausschließlich diese zu verwenden, und mehrzeilige Kommentare mit Anfangs- und Endtoken nur, um testweise einen bestimmten Codeabschnitt unwirksam zu machen.

lohnt es sich mitten in die funktionen zu kommentieren oder in die schleifen, bedingungen

Ja. Mein Motto ist immer: Wenn man den eigentlichen Code ausblendet und nur die Kommentare bleiben, dann sollte der Programmablauf dennoch grob erkennbar und nachvollziehbar sein.

oder ist es eher sinnvoll das außerhalb zu machen?

Sowohl, als auch. Als "Überschrift" zu einer Funktion notiere ich oft einen Kommentar, der den Zweck, die Aufrufparameter und das Funktionsergebnis erklärt, ggf. die zulässigen Randbedingungen oder ein dokumentiertes Verhalten im Fehlerfall.

So long,
 Martin