Документация IDE - Документирование modelFactory ()

Question

Мне любопытно, могу ли я документировать мои modelFactory(), чтобы они были доступны через всплывающую подсказку doc во время разработки в Netbeans.Мои модели проходят через modelFactory (), поэтому я могу просто сделать .....

$item = modelFactory('item')->getBy('user_count > 8');

, и это даст мне массив моделей или только 1 объект в зависимости от того, есть ли несколько результатов.Это действительно сильно сжимает мой код.Проблема в том, что когда другие разработчики начинают использовать это, я бы хотел, чтобы он знал, какие функции доступны для $item.Имейте в виду, что хотя на этот раз это модель «предмета», в следующий раз это может быть пользователь, запись в блоге или что-то еще, что нам нужно.

Возможно ли документировать эту функцию для NetBeans?Я знаю, что если я сделаю $item = new Item();, он сможет распознать, что доступно.

update

Часть, которую я ищу, состоит в том, как рассказать своей IDEчто выходные данные ModelFactory являются моделью $ item, поэтому он знает, где искать документацию метода.

Answer 1

Комментарий @var PHPDoc - это то, что вам нужно. например ...

/**
 * @var core\SuperItemModel $item
 */
$item = modelFactory('item')->getBy('user_count > 8');
// the IDE will know that $item is of type core\SuperItemModel now...

Answer 2

В нашем проекте PHP мы используем PHPDocumentor (http://www.phpdoc.org/) для нашей документации.

Кстати, я хорошо работаю с netbeans.