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

Question

我有这个带有可选参数的构造函数.这个问题的主要问题是可用性.使用我的框架的开发人员会立即头疼,因为他不知道他是否可以提供论证,什么样的论点,或者他是否根本不能.结论:这很糟糕.但是如果某人有像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]参数？

Answer 1

声明一个参数并给它一个预设:

public function __construct($my_argument = 0) 

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

show ([$my_argument])