Wie dokumentiere ich den code?

... komplette Frage anzeigen

1 Antwort

//pastebin.com/3fpkdRpu

//pastebin.com/ATAx7kyb

bitte

Antwort bewerten Vielen Dank für Deine Bewertung
Kommentar von fluffiknuffi2
02.05.2016, 09:57

Die Skripte sind doch bereits kommentiert?

0
Kommentar von triopasi
02.05.2016, 10:59

Das ist eine Erklärung aber das sind definitiv keine guten Kommentare, die man so in seinen Code schreiben sollte.

0
Kommentar von triopasi
02.05.2016, 18:49

War/Bin am Handy, da is nicht mit viel schreiben, sorry. Allgemein: Das Wichtigste ist meiner Meinung nach "Nichts kommentieren was eh schon offensichtlich ist.", denn: auch zu viele Kommentare machen den Code unübersichtlich! Hier bei dem Minicode naja, das ist alles recht offensichtlich, aber ich würde wsl dazu tendieren nur einen "Beschreibungskommentar" drüber setzten anstatt das IF etc nochmal einzeln zu beschreiben. Aber bei Funktionen zB da reicht dann ein Kommentar zur gesamten Funktion zusammen mit einem Funktionsnamen der für sich spricht. Wenn die Funktion zu lang istvsollte sie eh aufgeteilt werden. Ausserdem wird nicht kommentiert WIE der Code etwas macht sondern nur WAS er macht. Sprache allgem. schon englisch, genau wie die Benennung der Variablen etc, aber wer nur für sich schreibt, was solls... man sollte sich vllt trotzdem ans Englisch gewöhnen.

0
Kommentar von triopasi
02.05.2016, 18:50

Cool, die Zeilenumbrüche wurden alle entfernt. Hoffe man kanns trotzdem erahnen wo die hin sollten.

0

Was möchtest Du wissen?