Angenommen wir haben einen neuen Algorithmus entwickelt der genauso genial wie unleserlich ist. Wie soll der arme Programmierer, der diesen lesen muss, wissen, was er machen soll? Sicher, wir könnten eine Text-Datei mitliefern in der wir das erklären, aber es geht auch einfacher! Jede Programmiersprache bietet die Möglichkeit den Code zu kommentieren.
In C++ sehen Kommentare so aus:
// Hallo, ich bin ein einzeiliger Kommentar
kein Kommentar
/* Hihi, ich dagegen bin
mehr
zeil
ig
:p */
Generell sollte man die einzeiligen Kommentare bevorzugen -> denn dann kann man ganze Codeblöcke mit /* und */ Auskommentieren. Denn /* */ kann man leider nicht schachteln. Ein /* Hallo /* Frosch */ Welt */ ist also nicht erlaubt!Kommentieren ist wichtig, sollte aber nicht übertrieben werden. Man sollte immer nur unleserliche Stellen oder ungewöhnliche Sachen kommentieren. Nie zuviel, aber auch nie zuwenig.
Man sollte darauf achten zu kommentieren was der Code macht, und nicht wie. (Die Semantik beschreiben, nicht die Syntax). Denn ein cout<<"Hello Worl"; //gibt "Hello World" aus ist sinnlos. Dass hier "Hello World" ausgegeben wird, erkennt man ja auf den ersten Blick.
Später werde ich auf die Wichtigkeit des Kommentierens eingehen, aber momentan ignorieren wir diese Wichtigkeit noch.