IDE文档 - 记录modelFactory()

时间:2011-11-14 16:52:16

标签: php netbeans code-documentation

我很好奇我是否有可能记录我的modelFactory(),因此当你在Netbeans中开发时,可以通过doc helper工具提示访问它。我的模型通过modelFactory(),所以我可以做.....

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

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

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

更新

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

2 个答案:

答案 0 :(得分:0)

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

顺便说一句,我和netbeans合作得很好。

答案 1 :(得分:0)

@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...