Профессиональное программирование на PHP

Страница 42 из 591


44

Глава 1 Стили кодирования

Краткое описание - краткая (однострочная) характеристика элемента, описанного в данном блоке. Подробное описание - текстовый блок произвольной длины. В блоке Подробное описание допускается использование HTML-тегов для особого форматирования. Теги - список тегов phpDocumentor. Ниже перечислены важные phpDocument ог-теги.

Описание тегов

©package [имя пакета] ©author [имя автора] ®var [тип]

©param [тип [описание]] ©return [тип [описание]]

название пакета;

информация об авторе;

тип для директивы var, следующей за комментарием;

тип входных параметров функции, следующей за данным блоком; тип вывода функции.

Документирование начинается с создания заголовочного блока для файла.

* Здесь приведен пример блока краткого описания

* Это развернутое описание, в котором можно

* привести более подробную информацию.

* ©package Primes

* ©author George Schlossnagle */

Данный блок должен объяснять, для чего применяется этот файл; в нем также необходимо задать тег ©package (имя пакета) для файла. Если тег ©package не переписан в отдельном классе или функции, то он будет наследоваться другими phpDocument ог-бло-ками в данном файле.

Затем разработчик пишет документацию для функции. Пакет phpDocumentor обладает развитой логикой, но ему требуется помощь. Комментарий документации для функции или класса должен непосредственно предшествовать объявлению-в противном случае он будет применен к промежуточному коду. Необходимо отметить, что в следующем примере для одного входного параметра данной функции задается тег ©param, а возвращаемое функцией значение описывается тегом ©return: /**

Определяем, является ли число простым (примитивно)

Определяем, является ли число простым (почти самый медленный

способ из возможных).

<code>

for($i=0; $i<100; $i++) {

if (is_prime($i)) {

print "$i простое число\п" ,•

}

</code>

©param integer

©return boolean true если число простое, false в противном случае



  • игольчатые вентили продажа

  Hostland.Ru

 «Бесплатный хостинг Hostland.Su» © 2006