Tylko krótkie pytanie: widziałem, że niektóre funkcje PHP są komentowane u góry, przy użyciu nieznanego mi formatu:
/**
*
* Convert an object to an array
*
* @param object $object The object to convert
* @return array
*
*/
Moje IDE daje mi listę rozwijaną dla rzeczy, takich jak @param i @return, więc musi to być gdzieś udokumentowane. Próbowałem przeszukać google, ale w wyszukiwaniu nie uwzględniono symbolu @.
Jaki jest ten format komentowania i gdzie mogę znaleźć informacje na jego temat?
Odpowiedzi:
To jest składnia phpDoc.
Przeczytaj więcej tutaj: phpDocumentor
źródło
Funkcje:
Zajęcia:
Przykładowy plik:
Źródło: standardy PEAR Docblock Comment
źródło
Możesz uzyskać komentarze do konkretnej metody, używając klasy ReflectionMethod i wywołując -> getDocComment ().
http://www.php.net/manual/en/reflectionclass.getdoccomment.php
źródło
Musisz to sprawdzić: standardy Docblock Comment
http://pear.php.net/manual/en/standards.sample.php
źródło