Phpdoc — это стандарт для документирования PHP кода. Основные директивы, используемые в phpdoc, включают в себя:
- @param — описывает параметры функции или метода.
- @return — описывает тип возвращаемого значения функции или метода.
- @throws — описывает исключения, которые могут быть сгенерированы функцией или методом.
- @var — описывает свойство класса или переменную.
- @deprecated — указывает, что функция или метод устарел и скоро будет удален.
- @access — указывает уровень доступа к функции или методу.
- @see — указывает на связанный ресурс.
- @link — создает гиперссылку на связанный ресурс.
- @package — указывает пакет, в котором находится функция или класс.
- @subpackage — указывает подпакет, в котором находится функция или класс.
- @author — указывает автора кода.
- @version — указывает версию кода.
- @since — указывает версию PHP, с которой функция или метод доступен.
- @inheritdoc — наследует документацию от родительского класса или интерфейса.
- @global — описывает глобальную переменную.
- @category — указывает категорию, к которой относится функция, метод или класс.
- @example — предоставляет пример использования функции, метода или класса.
- @filesource — вставляет содержимое файла в документацию.
- @ignore — исключает функцию, метод или класс из документации.
- @internal — помечает функцию, метод или класс, как используемые только внутри библиотеки или пакета.
- @license — указывает лицензию, которая применяется к коду.
- @method — описывает метод, который может быть вызван в статическом контексте.
- @name — указывает альтернативное имя для функции, метода или класса.
- @param-read — указывает, что параметр используется только для чтения.
- @param-write — указывает, что параметр используется только для записи.
- @property — описывает свойство класса.
- @property-read — указывает, что свойство используется только для чтения.
- @property-write — указывает, что свойство используется только для записи.
- @static — указывает, что метод или свойство является статическим.
- @todo — помечает функцию, метод или класс, как незаконченный и оставляет заметку для будущей работы.
- @uses — указывает на другой элемент кода, который используется функцией, методом или классом.
Эти директивы помогают создавать более понятную и информативную документацию для PHP кода, что упрощает понимание и использование этого кода другими разработчиками.