Използването docblock коментари в PHP

синтаксис phpDoc

Може би си струва да се отбележи, че всяка линия в рамките на блок трябва да започва с *. Имена описания предшествани от знака @.

phpDoc може да се опише не само отделни части от кода, но на целия скрипт файл, да се установят в началото на файла. Такъв блок се нарича глава.

Описания @access. @final и @abstract са били свързани с PHP 4, но сега те не могат да се използват, защото те са загубили значение с появата на модификатори за достъп и ключовите думи, окончателни и абстрактни.

Всеки docBLock е разделен на няколко секции:

Разделянето секция за нулевата низ.

Аз силно съкратен многословно описание на методите и класове, като се избягват съкращения в пример. Обърнете внимание на общия принцип за документиране и ЕВРОВОК синтаксис.

Използване на @see маркер

И тук е един пример за съвети (Eclipse код подпомагане), които могат да предлагат среда за разработка, в този случай, Eclipse.

Също така, развитието на околната среда може да се изходи улики въз основа на docBlock. Например, ред, който се появява, когато мишката върху Zend_Acl_Role_Registry :: добави () име метод.

Има клас с публични и защитени помощни средства, които се използват главно от клас черта примеси. Как да внасят в основния клас на цяла черта автоматичното клас, който е в vidilis като публични методи и в рамките на класа, IDE не Кълна се в частните методи?