PHP docBlock @return className

时间:2012-03-17 16:41:36

标签: php netbeans phpdoc

如何创建一个PHP DocBlock,声明一个表示类返回的@return。通过

,目前这很简单
/**
* This returns an object of the "User" class
* @return User
*/
public function getUser() { return $this->user; }

我使用它通过我的IDE获取智能感知这些返回值。 (在我看来是Netbeans)

但是我有一个基于变量名返回类的类。 (例如:)

/**
* This returns an object of the $param
* @param String $className
* @return ???
*/
public function getSomeObject($className) { return new $className(); }

我正在尝试为此创建智能感知,但我不确定这是否真的可行。

例如,当我打电话

$someClass = new MyClass();
$var = $someClass->getSomeObject('Address');

我希望我的IDE能够显示变量$ var的intellisense(它将包含一个Object of Address)

2 个答案:

答案 0 :(得分:2)

有必要提一下该方法返回一个对象:

/**
* [...]
* @return object
*/

最终有一些细节:

* @return object Object of class $className

请参阅docs for @return

答案 1 :(得分:2)

除非您可以列出所有潜在的退货类型,

@return User|Address|Sandwich|Coiture

IDE可以自动完成汇总 所有方法/属性来自整个类列表,然后我不认为它。