Nur eine kurze Frage: Ich habe gesehen, dass einige PHP-Funktionen oben in einem mir unbekannten Format kommentiert werden:
/**
*
* Convert an object to an array
*
* @param object $object The object to convert
* @return array
*
*/
Meine IDE gibt mir eine Dropdown-Auswahl für Dinge wie @param und @return, daher muss sie irgendwo dokumentiert werden. Ich habe versucht, Google zu durchsuchen, aber das @ -Symbol wird nicht in die Suche einbezogen.
Was ist dieses Format für Kommentare und wo finde ich einige Informationen dazu?
Antworten:
Das ist die phpDoc-Syntax.
Lesen Sie hier mehr: phpDocumentor
quelle
Funktionen:
Klassen:
Beispieldatei:
Quelle: PEAR Docblock Kommentarstandards
quelle
Sie können die Kommentare einer bestimmten Methode abrufen, indem Sie die ReflectionMethod-Klasse verwenden und -> getDocComment () aufrufen.
http://www.php.net/manual/en/reflectionclass.getdoccomment.php
quelle
Sie müssen dies überprüfen: Docblock-Kommentarstandards
http://pear.php.net/manual/en/standards.sample.php
quelle