Просто быстрый вопрос: я видел, что некоторые функции PHP прокомментированы вверху в формате, который мне неизвестен:
/**
*
* Convert an object to an array
*
* @param object $object The object to convert
* @return array
*
*/
Моя IDE дает мне раскрывающийся список для таких вещей, как @param и @return, поэтому это должно быть где-то задокументировано. Я пробовал искать в Google, но он не будет включать в свой поиск символ @.
Что это за формат комментирования и где я могу найти информацию о нем?
Ответы:
Это синтаксис phpDoc.
Подробнее здесь: phpDocumentor
источник
Функции:
Классы:
Образец файла:
Источник: стандарты PEAR Docblock Comment
источник
Вы можете получить комментарии к конкретному методу, используя класс ReflectionMethod и вызвав -> getDocComment ().
http://www.php.net/manual/en/reflectionclass.getdoccomment.php
источник
Вы должны проверить это: Стандарты комментариев Docblock
http://pear.php.net/manual/en/standards.sample.php
источник