Wissensarchiv für Entwickler

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.

===== PHPDoc =====


Mit PHPDoc können Variablen, Funktionen, Methoden und Klasse im PHP-Quelltext dokumentiert werden.
In Entwicklungsumgebungen, wie z. B. [[phpstorm|PhpStorm]], beeinflusst diese Dokumentation den Autovervollständiger,
da die IDE auslesen kann, welche Daten von einer Methode als Parameter erwartet werden und von welchem Typ der Rückgabewert ist.


//Beispiele://

^ Syntax ^ Beispiel ^ Beschreibung ^
| @deprecated Version Beschreibung | @deprecated 1.0 wird durch getCount() abgelöst | Kennzeichnet eine Methode als "veraltet" |
| @param Typ Variable Beschreibung | @param string $username Benutzername | Definiert den Parameter einer Funktion/Methode |
| @return Typ Beschreibung | @return PDO Datenbankverbindung | Definiert den Rückgabewert einer Funktion/Methode |
| @var Typ Variable Beschreibung | @var int Anzahl | Legt den Typ einer Variable fest |
| @method Typ Methode | @method string getRufnummer | Ergänzt eine Klasse um eine Methode, die z. B. durch die [[magische_methoden#funktion_call|Magische Funktion "__call"]] aufgerufen wird |
| @inheritDoc | @inheritDoc | Übernimmt die Beschreibung vom Interface oder von Elternklassen |

Mögliche Typen

  * bool oder boolean
  * int oder integer
  * mixed 
  * string
  * void
  * Namen einer PHP-Klasse (z. B. PDO)
  * null (nur als Rückgabewert bei @return möglich)

Hinweise: Es ist auch die Angabe von mehreren Typen möglich. Diese werden dann durch einen senkrechten Strich "|" getrennt. Durch ein nachstehendes [] wird deklariert, dass der vorangestellte Typ innerhalb eines Arrays ausgeliefert wird.

//Beispiel://

<code>
/**
* @param int $groupId Gruppen-ID
* @return user[]
*/
</code>

In diesem Beispiel wird von der Funktion die ID einer Gruppe als integer erwartet. Als Rückgabewert wird ein Array mit Objekten der Klasse "user" zurückgegeben. Dank dieser Dokumentation "weiss" die Entwicklungsumgebung, dass die Objekte in dem zurückgegebenen Array von der Klasse "user" sind und stellt die Variablen und Methoden dieser Klasse bei der Autovervollständigung zur Verfügung.

Wissensarchiv für Entwickler

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge