Kommentare in PHP

Leon HoffmannProgrammieren, Tutorial0 Comments

Kommentare in PHP

Kommentare in PHP

Warum gibt es Kommentare in PHP und anderen Programmiersprachen? Ein dokumentierter Code ist wichtig, damit du und andere Programmierer leichter verstehen wofür welcher Block Code verantwortlich ist. Das fördert die Orientierung in einer PHP-Datei und hilft dabei das Programm besser lesen und bearbeiten zu können. Nicht oder nur wenig kommentierter Code ist ein Problem. Ob und wie du deinen Code kommentierst, ist ein Signal dafür, wie professionell du programmierst.

Kommentare können auch genutzt werden, um Änderungen an deinen Code zu testen. Denn du kannst einzelne Zeilen oder Blöcke mit Kommentarzeichnen umranden und diese damit vorläufig aus dem Projekt entfernen, ohne den Code wirklich zu löschen (das so genannten Comment-Out). Gibt es Probleme oder hat das „Löschen“ des Codeblocks nicht den gewünschten Effekt, kannst du die Kommentarzeichen wieder entfernen und nach einer anderen Lösung suchen. Dauerhaft solltest du natürlich keine „auskommentierten“ Code-Zeilen in der PHP-Datei belassen, denn die eigentliche Funktion von Kommentaren ist es, deine Programme zu dokumentieren, also dir und anderen Entwicklern hilfreiche Hinweise zu hinterlassen.

Arten von Kommentaren in PHP

Unterschieden wird zwischen zwei Arten von Kommentaren: Einzeilige Kommentare und mehrzeilige Kommentare.
Einzeilige Kommentare stehen am Ende einer Zeile und werden mit // eingeleitet.
Mehrzeilige Kommentare gehen logischerweise über mehrere Zeilen und beginnen mit /* und enden mit */.

<!DOCTYPE html>
<html lang="de">

<head>
  <meta charset="UTF-8">
  <title>Kommentare in PHP</title>
  <meta name="description" content="Hier fügen wir einzeilige und mehrzeilige Kommentare in PHP ein">
</head>

<body>
  <?php echo "Es folgt ein einzeiliger Kommentar"; // einzeiliger PHP-Kommentar
  echo "Darunter folgt ein mehrzeiliger Kommentar Kommentar";
  /*Die ist ein
  mehrzeiliger Kommentar*/
  ?>
</body>

</html>

Kommentare in HTML

Da du oft HTML und PHP in einem Dokument schrieben wirst, muss an dieser Stelle auch gezeigt werden, wie Kommentare in HTML funktionieren.

Auch HTML unterscheidet in einzeilige Kommentare und mehrzeilige Kommentare. Allerdings haben beide die selbe Zeichenfolge. Beide beginnen mit <!-- und enden mit -->

<!DOCTYPE html>
<html lang="de">

<head>
  <meta charset="UTF-8">
  <title>Kommentare in HTML</title>
  <meta name="description" content="Hier fügen wir einzeilige und mehrzeilige Kommentare in HTML ein">
</head>

<body>
  <h1>Ein Überschrift</h1>
  <!-- einzeiliger Kommentar -->
  
  Ein Text
  <!-- Dies ist ein
  mehrzeiliger Kommentar -->
</body>

</html>

Conditional Comments

Kommentare können auch helfen, deinen Code besser darzustellen.

Während du für das Web programmierst, wirst du immer wieder auf das Problem der Browser-Kompatibilität stoßen. Denn alle Browser interpretieren Code unterschiedlich. Besonders aus der Reihe tanzt der Internet Explorer. Zur Abhilfe hat Microsoft die Conditional Comments veröffentlicht. Dies sind spezielle und bedingte HTML-Kommentare, die nur vom Internet Explorer ab Version 5 ausgelesen und beachtet werden. Alle anderen Browser ignorieren diese Kommentare.

Dies sind die Kommentare der entsprechenden Versionen:
[if IE] alle Versionen (ab 5.0 – 9)
[if IE 6] alle Versionen 6
[if lt IE 8] alle Version vor 8
[if lte IE 8] alle Version bis 8
[if gte IE 5.5] alle Versionen ab 5.5

So sieht dann ein Conditional Comment im Code aus:

<!DOCTYPE html>
<html lang="de">

<head>
  <meta charset="UTF-8">
  <title>Kommentare in HTML</title>
  <meta name="description" content="Hier fügen wir einzeilige und mehrzeilige Kommentare in HTML ein">
  <link rel="stylesheet" href="style.css">
  <!--[if IE]>
  <style>@import url(ie.css);</style>
  <![endif]-->
</head>

<body>
  
</body>

</html>

Kommentare im Frontend

Da Kommentare nur Informationen für Entwickler und teilweise für Browser sind, werde diese im Frontend für den User nicht dargestellt, wie im folgenden Beispiel zu sehen ist. Das Beispiel zeigt alle in diesem Teil des PHP-Tutorials verwendeten Code-Blocks mit ihren Kommentaren.

Kommentare in PHP

Kommentare in PHP

Ausblick

Im nächsten Teil befassen wir uns mit Variablen in PHP.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.