IDE文档-记录modelFactory()

Question

我很好奇我是否有可能记录我的modelFactory()，所以当你在Netbeans中开发时，可以通过文档帮助工具提示访问它。我的模型通过modelFactory()传递，因此我可以执行.....

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

它会给我一个模型数组或者一个对象取决于是否有多个结果。它确实大大压缩了我的代码。问题是当其他开发人员开始使用它时，我希望它知道$item可以使用哪些功能。请记住，虽然这次是一个"项目"模型，但下一次它可能是一个用户、博客文章或任何我们需要的东西。

有可能为NetBeans记录这个功能吗?我知道如果我打开$item = new Item();，它就能识别出什么是可用的。

我正在寻找的部分是如何告诉我的IDE, ModelFactory的输出是一个$item模型，因此它知道在哪里寻找方法文档。

Answer 1

在我们的PHP项目中，我们使用PHPDocumentor (http://www.phpdoc.org/)作为文档。

我可以很好地使用netbeans。

Answer 2

@var PHPDoc注释就是你想要的。例如…

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