PHP Tutorial: Kommentare im Quellcode

Wenn man Scripte schreibt, du nur sehr kurz sind, kommt man meistens ohne Kommentare im Quellcode aus. Sobald dieses aber umfangreicher werden oder mehrere Personen an diesem Quellcode schreiben müssen, dann wird es fast zur Pflicht, dass man sinnvolle Kommentare verwendet.

Was genau sind Kommentare?

Texte, die als Kommenar markiert werden, werden von dem PHP-Parser ignoriert. In den Kommentaren muss daher kein PHP-Code stehen.

Kommentare können ein- oder mehrzeilig sein. Bei einzeiligen Kommentaren steht nur am Anfang des Kommentar entweder ein "//" oder ein "#". Mehrzeilige Kommentare haben ein Start- und ein Endsymbol. Nachfolgend ein paar Beispiele für Kommentare:

  1. <?php
  2.    // Ich bin ein Kommentar
  3.    echo 'Hello World'; // Auch ich bin ein Kommentar
  4.    /*
  5.       Ich bin auch ein Kommentar.
  6.       Ich kann aber mehrzeilig sein.
  7.    */
  8. ?>

Bei der mehrzeligen Variante gibt es noch ein weitere Variante. Diese wird genutzt, um die Methoden der Klassen zu beschreiben. Diese Kommentare beginnen mit "/**". In diese Kommentare kann man dann weitere Informationen zu der Methode schreiben. Die Texte in diesem Kommentar werden dann sogar von den Editoren wie dem ZDE angezeigt, wenn man die Methode aufruft.

  1. <?php
  2.    class test {
  3.       /**
  4.        * Ich bin eine Beschreibung für eine Variable
  5.        *
  6.        * @var string
  7.        */
  8.       var $variable;
  9.  
  10.  
  11.       /**
  12.        * Ich bin eine Beschreibung für eine Methode
  13.        *
  14.        * @param integer $variable
  15.        * @return boolean
  16.        */
  17.       function methode1($variable) {
  18.          // Hier steht irgendwelcher Code
  19.          return true;
  20.       }
  21.  
  22.    }
  23. ?>

Zur Übersicht der PHP Tutorials.