====== Синтаксис ======


@api

@author [имя] [<адрес электронной почты]]

@copyright <описание>

@deprecated [<"Семантическая версия">] [: <"Семантическая версия">] [<description>]

@example [URI] [<описание>]

{@example [URI] [: <старт> .. <конец>]}

@inheritDoc

@internal

{@internal [description]}}


@license [<Идентификатор SPDX> | URI] [имя]

@method [return "Type"] [name] (["Type"] [parameter], [...]) [description]

@package [уровень 1] \ [уровень 2] \ [и т. д.]

@param ["Тип"] [имя] [<описание>]

@property ["Тип"] [имя] [<описание>]

@return <"Тип"> [описание]

@see [URI | "FQSEN"] [<description>]

@since [<"Семантическая версия">] [<description>]

@throws ["Type"] [<description>]

@todo [описание]

@uses [файл | "FQSEN"] [<description>]

@var ["Type"] [element_name] [<description>]

@version ["Семантическая версия"] [<description>]

@filesource - включает текущий файл в результаты анализа phpDocumentor

@link [URI] [<description>] - тег Link помогает определить отношение или ссылку между структурными элементами .
замечания
#

«PHPDoc» - это раздел документации, в котором содержится информация об аспектах «Структурного элемента» - PSR-5

Аннотации PHPDoc - это комментарии, которые предоставляют метаданные обо всех типах структур в PHP. Многие популярные IDE настроены по умолчанию для использования аннотаций PHPDoc для обеспечения понимания кода и выявления возможных проблем до их возникновения.

Хотя аннотации PHPDoc не являются частью ядра PHP, в настоящее время они сохраняют статус проекта с PHP-FIG как PSR-5 .