Comment marquer qu'un argument est facultatif dans PHPDoc?

Question

J'ai ce constructeur qui prend un argument optionnel. Le principal problème avec cette facilité d'utilisation est. Le développeur à l'aide de mon cadre va attraper un mal de tête instantanément parce qu'il ne sait pas s'il peut fournir un argument, ce genre d'argument, ou s'il ne peut pas du tout. Conclusion: Il suce juste. Mais PHPDoc peut aider un peu si quelqu'un a un IDE raisonnable comme Netbeans installé;)

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

Comment pourrais-je utiliser PHPDoc ici pour indiquer qu'il peut être fourni un argument [tpl $] en option?

Answer 1

Déclarer un paramètre et lui donner un préréglage:

public function __construct($my_argument = 0) 

mon IDE (PhpED, qui est sensible phpDoc) interprète correctement. phpDoc devrait aussi, et de mettre le paramètre en accolades:

show ([$my_argument])

Answer 2

Vous pouvez utiliser classe de réflexion aussi.