Шаблон:PhpDocumentor
Перейти к навигации
Перейти к поиску
| Список дескрипторов phpDocumentor | ||
|---|---|---|
| Дескриптор | Описание | Пример |
@author |
Автор | /**
* Sample File 2, phpDocumentor Quickstart
*
* Файл из документации к phpDocumentor
* демонстрирующий способы комментирования.
* @author Greg Beaver <cellog@php.net>
* @version 1.0
* @package sample
* @subpackage classes
*/
|
@version |
Версия кода | |
@package |
Указывает пакет к которому относится код | |
@subpackage |
Указывает подпакет | |
@global |
Описание глобальных переменных | /**
* DocBlock для глобальной переменной
* @global integer $GLOBALS['myvar'] далее идет функция с с глобальной переменной
* или глобальная переменная, в этом случае необходимо указать ее имя
* @name $myvar
*/
$GLOBALS['myvar'] = 6;
|
@name |
Имя, метка | |
@staticvar |
Описание статических переменных | /**
* @staticvar integer $staticvar
* @return возвращает целое значение
*/
|
@return |
Описание возвращаемого значения | |
@todo |
Заметки для последующей реализации. | /**
* DocBlock с вложенными списками
* @todo Простой TODO список
* - item 1
* - item 2
* - item 3
* @todo Вложенный TODO список
* <ol>
* <li>item 1.0</li>
* <li>item 2.0</li>
* <ol>
* <li>item 2.1</li>
* <li>item 2.2</li>
* </ol>
* <li>item 3.0</li>
* </ol>
*/
|
@link |
Ссылка | /**
* Это пример {@link http://www.example.com встроенной гиперссылки}
*/
|
@deprecated (@deprec) |
Описание устаревшего блока | /**
* @deprecated описание
* @deprec синоним для deprecated
*/
|
@example |
Пример | /**
* @abstract
* @access public или private
* @copyright Имя дата
* @example /path/to/example
* @ignore
* @internal закрытая информация для специалистов
* @param тип [$varname] описание входного параметра
* @return тип описание возвращаемого значения
* @see имя другого элемента (ссылка)
* @since версия или дата
* @static
*/
|
@see |
Ссылка на другое место в документации | |
| Другие дескрипторы | ||
@copyright · @license · @filesource · @category · @since · @abstract · @access · @example · @ignore · @internal · @static · @throws · @uses · @tutorial
| ||
Документация
Шаблон-таблица — всегда скрыт, в связи с большим размером.