Интеграция PHPDoc в IDE NetBeans(Часть 1)

Эта статья посвящена вопросу о комментировании кода в PHP по стандартам PHPDoc. Что же такое PHPDoc?
PHPDoc является аналогом Javadoc адаптированным для использования в среде php.  Он поддерживает как объектно-ориентированный. так и процедурный код.

В среде NetBeans присутствует интегрированная поддержка PHPDoc. Поэтому комментирование кода представляет следующие приемущества:

1. Повышение скорости разработки.

2. Повышение качества сопровождения.

3. Подсветка синтаксиса.

4. Автодополнение процедур и функций.

5. Автодополнение полей и методов классов.

6. Отладка.

 Давайте рассмотрим основные способы использования на примере класса по работе с базой данных.

Итак давайте создадим класс Database в новом проекте. При создании класса NetBeans автоматически генерирует следующий код:

Все что находиться в блоке комментария начинающегося с /** интерпретируется средой разработки как описание данного класса/метода/функции/переменной и т.д.

В данном случае у нас автоматически появляется имя автора данного класса.

Теперь при создании экземпляра данного класса мы увидим его описание.

Как вы поняли директива @author задает имя автора.
Добавим в класс несколько методов.

Теперь когда мы будем вызвать методы класса, данные методы будут доступны для автодополнения. Но они не будут содержать никаких описаний. Для того что бы добавить описание функции необходимо перед объявлением методо набрать /** и нажать ввод. Появится автоматическая заготовка для описание метода и его входных переменных.

Директива @param задает описание входящих параметров, так же тут могут быть использованы следующие директивы:
@access - описание типа доступа (public, private, protected)
@return - тип возвращаемого значения

После описания всех этих параметров при вызове метода увидим следующее: