User Tools

Site Tools


phpdoc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
phpdoc [2020/12/10 12:23] – создано chifekphpdoc [2023/09/14 06:06] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Синтаксис ====== ====== Синтаксис ======
  
-# 
  
 @api @api
 +
 @author [имя] [<адрес электронной почты]] @author [имя] [<адрес электронной почты]]
 +
 @copyright <описание> @copyright <описание>
 +
 @deprecated [<"Семантическая версия">] [: <"Семантическая версия">] [<description>] @deprecated [<"Семантическая версия">] [: <"Семантическая версия">] [<description>]
 +
 @example [URI] [<описание>] @example [URI] [<описание>]
 +
 {@example [URI] [: <старт> .. <конец>]} {@example [URI] [: <старт> .. <конец>]}
 +
 @inheritDoc @inheritDoc
 +
 @internal @internal
 +
 {@internal [description]}} {@internal [description]}}
 +
 +
 @license [<Идентификатор SPDX> | URI] [имя] @license [<Идентификатор SPDX> | URI] [имя]
 +
 @method [return "Type"] [name] (["Type"] [parameter], [...]) [description] @method [return "Type"] [name] (["Type"] [parameter], [...]) [description]
 +
 @package [уровень 1] \ [уровень 2] \ [и т. д.] @package [уровень 1] \ [уровень 2] \ [и т. д.]
 +
 @param ["Тип"] [имя] [<описание>] @param ["Тип"] [имя] [<описание>]
 +
 @property ["Тип"] [имя] [<описание>] @property ["Тип"] [имя] [<описание>]
 +
 @return <"Тип"> [описание] @return <"Тип"> [описание]
 +
 @see [URI | "FQSEN"] [<description>] @see [URI | "FQSEN"] [<description>]
 +
 @since [<"Семантическая версия">] [<description>] @since [<"Семантическая версия">] [<description>]
 +
 @throws ["Type"] [<description>] @throws ["Type"] [<description>]
 +
 @todo [описание] @todo [описание]
 +
 @uses [файл | "FQSEN"] [<description>] @uses [файл | "FQSEN"] [<description>]
 +
 @var ["Type"] [element_name] [<description>] @var ["Type"] [element_name] [<description>]
 +
 @version ["Семантическая версия"] [<description>] @version ["Семантическая версия"] [<description>]
 +
 @filesource - включает текущий файл в результаты анализа phpDocumentor @filesource - включает текущий файл в результаты анализа phpDocumentor
 +
 @link [URI] [<description>] - тег Link помогает определить отношение или ссылку между структурными элементами . @link [URI] [<description>] - тег Link помогает определить отношение или ссылку между структурными элементами .
 замечания замечания
phpdoc.1607603024.txt.gz · Last modified: 2023/09/14 06:06 (external edit)