Wenn du eine Website fertig programmiert hast und die Site ist schon Online gestellt, dann bemerkt man später eventuell noch einige Fehler im Code, es können noch später Änderungswünsche vom Arbeitgeber getroffen werden oder ein anderer Mitarbeiter, wie auch immer, möchte an dem Code etwas ändern, so wird es einfacher, wenn man Kommentare hinzu schreibt. Man findet sich besser zurecht und es gibt eine klare Struktur, wann wo was anfängt und wo dann was aufhört. Es ist daher leichter Änderungen vor zu nehmen, da man nicht wieder den ganzen Code durch schauen muss, wo denn was nun eigentlich ist, deswegen schreibt man diese Kommentare. Oder es ist auch so, dass man den Code dann nicht mehr jeden Tag anschaut und dann vergisst man doch einiges und das hilft einem wieder auf die Sprünge
Natürlich sollten die Kommentare gut platziert sein und in kurzen prägnanten Worten geschrieben sein, es ist aber egal was man schreibt, hauptsache man versteht es und andere können es auch verstehen. Es gibt aber zwei Möglichkeiten Kommentare einzubinden.
Hier unterscheidet man zwischen:
- einzeiligen und
- mehrzeiligen
Kommentaren.
Einzeilige Kommentare bindest du mit zwei Schrägstrichen ein (engl. slashes).
Beispiel in (script removed)
<script type="text/javascript">
//Das ist der einzeilige Kommentar
alert("Das ist eine Ausgabe in einer Alertbox");
</script>
Dieser einzeilige Kommentar wird nicht geschlossen im Gegensatz zu den mehrzeiligen Kommentaren, da werden diese geschlossen.
Dies wird mit einem slash und sternchen gekennzeichnet /* und um den Kommentar zu beenden wird dies einfach umgedreht */ .
Du solltest aber nicht jedes Detail kommentieren, sonst kann es auch zur Verwirrung kommen. Damit kann man auch mehrere Zeilen Code auskommentieren, so dass es im Browser nicht angezeigt wird. Damit kannst du dann einiges ausprobieren ohne den Code wegzumachen, so dass du dann den Code doch wieder nehmen kannst, falls er nützlich war.
Im HTML werden Kommentare so eingebunden
