Thread Warum beim Programmieren kommentieren? (8 answers)
Opened by pktm at 2008-04-22 00:46

topeg
 2008-04-22 07:53
#108674 #108674
User since
2006-07-10
2611 Artikel
BenutzerIn

user image
Für mich gibt es mehrere Arten von Kommentaren.
Den "strukturellen Kommentar":
Code: (dl )
###### Ein- Ausgabe ######

Der ist für mich sehr wichtig, da ich mich leicht in meinem eigenen Code verirre und ich nicht mehr weiß, wo ich was stehen habe.

Den "beschreibenden Kommentar" in dem ich erkläre, warum ich etwas mache.
Code: (dl )
1
2
# hier wird die Codefunktion sinnvoll erklährt,
# obwohl das nicht immer klappt.

Der ist sinnvoll, da man leicht vergisst warum man etwas auf eine bestimmte Weise macht. Und Später ist es leichter den Code zu ändern, wenn einem eine bessere Methode einfällt.

Und natürlich die Schnittstellenbeschreibung (mit pod), in dem ich erkläre was die Funktionen machen. Schreibe ich meist zusammen mit den Funktions- und Klassenrümpfen, damit ich später selber noch weiß was in der Funktion stehen muss und das sie zurück liefert. meist Rahmen ich die pod Doku mit einem strukturellen Kommentar ein, damit ich beim programmieren nicht darüber stolper

View full thread Warum beim Programmieren kommentieren?