Kommentare in der Javascript-Programmierung

Beschreiben von Funktionen und Überlegungen

Um sich später wieder zurecht finden zu können, sind Kommentare im Skript selbst sehr sinnvoll und das gilt auch für Lösungen, die man mit Javascript erarbeitet hat. Es gibt dabei die Möglichkeit, einen mehrzeiligen Kommentar zu schreiben oder sich auf eine Zeile zu begrenzen.

Der Hintergedanke ist der, dass man Funktionen und Überlegungen zur aktuellen Skriptstelle niederschreibt, die etwa ein halbes Jahr später hilfreich sein können, wenn man wieder etwas verändern oder überprüfen soll.

Kommentare in der Programmierung anführen

... Befehle ... // Hier steht ein kurzer Kommentar
... Befehle ...
/* und hier kommt
ein langer
Kommentar */

Kommentare sind sehr nützlich, auch wenn dies von vielen nicht so angesehen wird. Witzigerweise schreiben Profis gerne Kommentare, um später eine Anleitung zu haben, welche Überlegung zu welcher Lösung geführt hat, während Anfänger Kommentare ablehnen, teils wegen der Tipparbeit und teils, weil eh klar ist, was man da macht.

Nur wenn man ein halbes Jahr später wieder das Skript aufruft, weil eine Änderung erwünscht ist, sieht die Geschichte schon anders aus. Dann ist man für jeden Hinweis froh, vor allem dann, wenn man selbst ein paar dutzend Projekte betreut und sich nicht mehr exakt an alles erinnern kann. Je komplexer die Programmierung ist, umso schwieriger wird es auch sein, sofort zu erkennen, was eigentlich der Sinn war oder wo man ansetzen könnte.

Im Beispiel habe ich zuerst einen einzeiligen Kommentar simuliert, der mit // eingeleitet wird. Das bedeutet, dass die Befehle davor normal abgearbeitet werden, aber jeglicher Text hinter diesen beiden Schrägstrichen wird als Kommentar erkannt und nicht berücksichtigt. Das kann auch nützlich sein, wenn man eine Zeile Code wegsperren will, sie später aber noch braucht.

Die zweite Variante ist der mehrzeilige Kommentar. Dieser wird in der gezeigten Form umschlossen, nämlich mit /* am Beginn und */ am Ende und dient oft am Beginn eines Skripts als Hinweis auf Autor und rechtliche Spielregeln, kann aber auch eine Erläuterung des Skripts und seine Funktionsweise beinhalten.

Lesen Sie auch

Javascript ist eine optimale Ergänzung zu HTML, allerdings gibt es für gewisse Bereiche schon bessere Lösungen wie etwa Formularabfragen per PHP und so manche grafische Lösung per CSS. Der Einstieg in Javascript gelingt recht rasch, kleine Lösungen sind auch bald realisiert, man muss Javascript aber richtig einbinden, um dann mit den Variablen arbeiten zu können.

Hat man die Variablen erst einmal verstanden und auch mit alert die ersten Meldungen zustande gebracht, gilt es, komplexer zu denken. Mit den Schleifen, Abfragen und Funktionen stehen viele Möglichkeiten zur Verfügung.

Diesen Artikel teilen

Kategorien

Grundlagen
HTML-Grundlagen
CSS-Grundlagen
Javascript-Grundlagen
PHP-Grundlagen
MySQL-Grundlagen
SEO-Grundlagen

Infos, Tipps, Vermarktung
Webdesign-Lexikon
Online-Werbung
PHP-Codeschnipsel