11.1. Dokumentations Block
Zurück  Kapitel 11. Source Dokumentation  Weiter

11.1. Dokumentations Block

Das Hauptelement der Dokumentation ist der Dokumentations Block bzw. DocBlock. Dieser besteht aus folgenden Elementen:

  • Kurzbeschreibung

  • mehrzeilige Langbeschreibung

  • DocBlock Tags

Ein DocBlock ist ein PHP - Kommentar im erweiterten C++ Stil. Ein DocBlock beginnt mit einem Slash (/) gefolgt von zwei Sternchen. Er endet mit Sternchen (*) und Slash (/). Jede Zeile dazwischen beginnt mit Sternchen (*). Ein DocBlock bezieht sich immer auf das folgende dokumentierbare PHP - Element.

Beispiel 11.1. Kommentarblock 

  
          
           /**
            * Kurzbeschreibung, eine Zeile in englischer Sprache
            *
            * mehrzeilige Beschreibung
            * in englischer Sprache 
            *
            * @author      Ralf Zschemisch <info@r23.de>
            * @version     1.0
            */
Zurück  Nach oben  Weiter
Kapitel 11. Source Dokumentation  Zum Anfang  11.2. Dokumentierbare PHP - Elemente