Wie markiert man in PHPDoc, dass ein Argument optional ist?

Question

Ich habe diesen Konstruktor, der ein optionales Argument annimmt. Das Hauptproblem dabei ist die Benutzerfreundlichkeit. Der Entwickler, der mein Framework verwendet, wird sofort Kopfschmerzen bekommen, weil er nicht weiß, ob er ein Argument angeben kann, welche Art von Argument, oder ob er überhaupt keins angeben kann. Fazit: Es ist einfach scheiße. Aber PHPDoc hilft vielleicht ein wenig, wenn jemand eine vernünftige IDE wie Netbeans installiert hat ;)

Also:

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

Wie kann ich PHPDoc hier verwenden, um anzugeben, dass ein optionales [$tpl]-Argument angegeben werden kann?

Answer 1

Deklarieren Sie einen Parameter und geben Sie ihm eine Voreinstellung:

public function __construct($my_argument = 0) 

meine IDE (phpEd, das phpDoc-empfindlich ist) interpretiert es korrekt. phpDoc sollte das auch tun und den Parameter in geschweifte Klammern setzen:

show ([$my_argument])

Answer 2

Sie können verwenden Reflexionsklasse auch dafür.