php - IDE 文档 - 记录 modelFactory()

Question

我很好奇我是否可以记录我的文档modelFactory()，以便在您在 Netbeans 中开发时可以通过 doc helper 工具提示访问它。我的模型通过 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 core\SuperItemModel $item
 */
$item = modelFactory('item')->getBy('user_count > 8');
// the IDE will know that $item is of type core\SuperItemModel now...