Kommentare sind ein wichtiger Bestandteil der Webprogrammierung, da sie es Entwicklern erleichtern, ihren Code zu dokumentieren und verständlicher zu machen.
Zusammengefasst:
- Dokumentation: Kommentare helfen Entwicklern, ihren Code zu dokumentieren und zu beschreiben, was jeder Abschnitt des Codes tut. Dies macht es anderen Entwicklern, die den Code später bearbeiten müssen, einfacher, ihn zu verstehen.
- Debugging: Kommentare können auch als Debugging-Hilfe verwendet werden, indem sie bestimmte Teile des Codes deaktivieren, um Fehler zu identifizieren.
- Code-Organisation: Kommentare können verwendet werden, um Code in Abschnitte zu unterteilen und ihn organisierter und lesbarer zu gestalten.
- Syntax: Die Syntax für Kommentare variiert je nach Programmiersprache. Es ist wichtig, die korrekte Syntax für die verwendete Sprache zu kennen, um sicherzustellen, dass Kommentare korrekt funktionieren.
Kommentare gibt es in der Webprogrammierung nicht umsonst. Viele tausende Zeilen Code können schnell unübersichtlich werden. Man möchte Klassen, Funktionen oder sonstigen Code gut strukturiert und leicht verständlich dokumentieren.
Hier kommt es eher darauf an, zu dokumentieren was Dein Script macht, weniger wie er es macht.
Man kommentiert also die Funktionalität, sodass man sich schnell wieder in den Code einarbeiten kann. Dennoch sollte man den Gebrauch von Kommentaren sinnvoll dosieren, um Überladung und Verwirrung zu vermeiden.
Auch können Kommentare Code ausblenden, sodass dieser nicht komplett aus dem Dokument genommen werden muss. Denn, wenn der Quelltext weiterverarbeitet wird, dann werden die Kommentare ignoriert und nicht ausgeführt.
Ich halte Kommentare für sehr wichtig und nutze diese großzügig. Die meisten HTML/CSS/JS Minify Lösungen löschen die Kommentare in der Ausgabe und bei PHP werden diese gar nicht erst mit verarbeitet.
Nachfolgend die Syntax zum Auskommentieren in Javascript, PHP, CSS und HTML.
Kommentare in JAVASCRIPT
In Javascript kommentiert man entweder eine Zeile oder einen Bereich aus.
- mit // am Anfang der Zeile kommentiert man die gesamte Zeile aus
- mit /* am Anfang und */ am Ende kommentiert man den gesamten Bereich aus
<script>
// Zeilenkommentar
// Ausgabe von Text durch Document.write
document.write(" Dies ");
document.write(" ist eine ");
document.write(" Ausgabe ");
/* Bereichskommentar
Folgender Abschnitt gibt
" Dies ist eine weitere Ausgabe "
im Browser aus.
*/
document.write(" Dies ");
document.write(" ist eine ");
document.write(" weitere Ausgabe ");
</script>
Kommentare in PHP
In PHP stehen Dir 2 verschiedene Arten von Kommentaren (Inline und Block) zur Verfügung. Dennoch gibt es 3 verschiedene Schreibweisen. Der PHP Interpreter überspringt die Kommentare und geht zur nächsten Zeile. Kommentare werden in der Ausgabe nicht angezeigt.
- mit // am Anfang der Zeile kommentiert man die gesamte Zeile aus
- als Alternative kannst Du auch # nutzen
- mit /* am Anfang und */ am Ende kommentiert man den gesamten Bereich aus
<?php //Dies ist ein Kommentar echo "Dies ist eine Ausgabe! <br>"; # Dies ist ein weiterer Kommentar echo "Wie man sieht, sind die Kommentare bei der Ausgabe nicht sichtbar."; /* Die erste Zeile des Kommentars Zweite Zeile des Kommentars Die letzte Zeile des Kommentars */ echo "Eine weitere Ausgabe."; ?>
Kommentare in CSS
In CSS werden Kommentare immer mit /* angefangen und */ abgeschlossen. Die Kommentare können mehrzeilig sein. Somit kann z.b. der Anfang der Stylesheet Datei ausgeklammert werden, um diese näher zu beschreiben.
/* Dies ist ein mehrzeiliger Kommentar */
Kommentare in HTML
HTML kommentiert mit einer etwas anderen Art. Hier wird <!– sowie –> genutzt. Die Kommentare können mehrzeilig sein. Das Auskommentieren von HTML-Code bezieht sich auf das Überspringen oder Deaktivieren eines bestimmten Abschnitts des Codes, indem man ihn innerhalb eines Kommentar-Tags einschließt. Folgendes Beispiel zeigt wie man einen Bereich in HTML auskommentiert.
<html> <head> <title>Kommentar im Body</title> </head> <body> <!-- Dies ist ein Kommentar, der im Quelltext auch angezeigt wird. --> <p>Ein beliebiger Absatz</p> <!-- Dies ist ein Kommentar über mehrere Zeilen.. --> </body> </html>
Kommentare in WordPress
Off-Topic, aber oft gefragt: Kommentare in WordPress
