nagon.net - бесплатная поставка трафика на ваши сайты
Логин:
Пароль:
Регистрация





Убрать рекламу с сайта чтобы не мешала!

PHPDoc справочник примеры тэги синтаксис. phpDocumentor комментарии. Скачать пример.

@abstract (Востребовано)
@abstract указывает, что элемент является абстрактным
@access (Востребовано)
@access указывает доступ к элементу [private | protected | public]
@author (Востребовано)
@author указывает автора
@category (Востребовано)
@category указывает категорию, используется для организации групп.
@copyright (Востребовано)
@copyright указывает авторство
@deprec (Востребовано)
@deprec указывает описание устаревшего блока. @deprec синоним @deprecated
@deprecated (Востребовано)
@deprecated указывает описание устаревшего блока. @deprecated синоним @deprec
@example (Востребовано)
@example указывает пример. Может быть ссылкой или путем к файлу.
@filesource (Востребовано)
@filesource указывает источник.
@global (Востребовано)
Тег @global указывает, что переменная глобальная.
@ignore (Востребовано)
Тег @ignore указывает, что элемент следует игнорировать.
@internal (Востребовано)
@internal
@license (Востребовано)
@license указывает ссылку на лицензию.
@link (Востребовано)
@link указывает ссылку
@name (Востребовано)
@name имя метки. Используется в связки с @global
@package (Востребовано)
@package указывает пакет к которому относится код. @package это логическое объединение файлов, классов, методов и тд. В документации PhpDocumentor используется на подобно категорий.
@param (Востребовано)
Тег @param описывает один аргумент функции или метода.
@return (Востребовано)
@return описывает возвращаемое значение функцией.
@see (Востребовано)
@see указывает ссылку на другое место в документации. Может быть названием файла, названием функции, названием метода класса.
@since (Востребовано)
@since
@static (Востребовано)
@static метка для статических элементов языка
@staticvar (Востребовано)
@staticvar описывает статическую переменную
@subpackage (Востребовано)
@subpackage подпакет, дейтсвует аналогично @package.
@throws (Востребовано)
@throws
@todo (Востребовано)
@todo заметки для последующей реализации
@tutorial (Востребовано)
@tutorial
@uses (Востребовано)
@uses
@var (Востребовано)
@var указывает описание для свойств класса
@version (Востребовано)
@version версия документа

Пример:

/**
* Имя или краткое описание объекта
*
* Развернутое описание
*
* @имя_дескриптора значение
* @return тип_данных
*/


Пример описания класса:

<?php
/**
* Название (имя) класса
*
* Полное описание
*
* @author Ф.И.О. <e-mail>
* @version 1.0
*/

class ExampleClass
{
/**
* Свойство класса
*
* @var Число с плавающей точкой (float)
*/
public $exampleVar = 3.5;

/**
* Метод класса
*
* @param string $text строка
* @return string
*/

public function escape($text) {
return addslashes($text);
}
}
?>


В описаниях допускается использование некоторых дескрипторов HTML:

* <b> — жирное начертание;
* <code> — код;
* <br> — разрыв строки;
* <i> — курсив;
* <kbd> — сочетание клавиш;
* <li> — элемент списка;
* <ol> — нумерованный список;
* <p> — абзац;
* <pre> — форматированный текст;
* <samp> — пример;
* <ul> — маркированный список;
* <var> — имя переменной.

Вас зовут:

Ваш комментарий:


Код на картинке: