如何在PHPDoc中标记参数是可选的?

时间:2009-12-31 12:35:30

标签: php oop phpdoc

我有一个带有可选参数的构造函数。这个问题的主要问题是可用性。使用我的框架的开发人员会立即头疼,因为他不知道他是否可以提供论证,什么样的论点,或者他是否根本不能。结论:这很糟糕。但是如果有人安装了像Netbeans这样合理的IDE,PHPDoc可能会有所帮助;)

所以:

class ChildClass extends ParentClass {
    public function __construct() {
    $tplFile = func_get_arg(0);
    if (!isset($tpl)) {
        $tpl = 'index';
    }
    parent::__construct($tpl);
    }
}

我如何在这里使用PHPDoc来表明可以提供一个可选的[$ tpl]参数?

2 个答案:

答案 0 :(得分:6)

声明参数并为其预设:

public function __construct($my_argument = 0) 

我的IDE(phpEd,这是phpDoc敏感的)正确解释它。 phpDoc也应该,并将参数放入大括号:

show ([$my_argument])

答案 1 :(得分:-1)

您也可以使用reflection class