IDE 文档 - 记录 modelFactory()答案

【问题标题】：IDE Documentation - Documenting modelFactory()IDE 文档 - 记录 modelFactory()
【发布时间】：2011-11-14 16:52:16
【问题描述】：

我很好奇是否可以记录我的modelFactory()，以便在您在 Netbeans 中进行开发时通过 doc helper 工具提示访问它。我的模型通过 modelFactory() 所以我可以做......

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

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

是否可以为 NetBeans 记录此功能？我知道如果我这样做$item = new Item();，它将能够识别可用的内容。

更新

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

【问题讨论】：

我使用过的大多数 ide 都知道如何解析 phpDoc cmets，通常你必须保持类所在的文件打开，但是大多数 ide 允许你解析 tose 标题，值得一试跨度>

标签： php netbeans code-documentation

【解决方案1】：

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

顺便说一句，我与 netbeans 配合得很好。

【讨论】：

【解决方案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...

【讨论】：

Gotcha... 是否有可能以某种方式记录 modelFactory() 总是看起来像一个指定的文件夹，而不是每次使用模型时都必须添加此注释。
您可以将一些辅助函数添加到您的modelFactory 或您正在创建对象的其他类（例如在您的控制器类中）。例如，添加一个getItemModel() 函数，并在函数注释中指定返回值的类型。现在你可以使用$item = $this->getItemModel()->getBy('blar');