Dokumentieren von Get/Post-Parametern mit Doxygen oder PHPDoc

Question

Ich habe in der Dokumentation nach PHPDoc gesucht und konnte keine gute Möglichkeit finden, die Post-Variablen zu dokumentieren, die ich an verschiedene Methoden gesendet habe.

Also fing ich an, Doxygen mit der Hoffnung zu betrachten, dass es mir eine bessere Möglichkeit geben würde, alle diese Variablen zu dokumentieren. Mein Code enthält viele AJAX-Anfragen, daher werden die meisten Variablen per Post gesendet.

Gibt es eine gute Möglichkeit für mich, die Post-Variablen in Doxygen zu dokumentieren? Ich habe Probleme, festzustellen, ob ich einen Fehler bekomme, der nur mit dem Standard-Parameter-Tag ausgeführt wird.

Wenn nicht, gibt es einen anderen Dokumentator, der in diesem Prozess hilfreich sein könnte? Oder sollte ich einfach alles manuell dokumentieren und die Suche nach einem automatischen Dokumentationswerkzeug ignorieren?

Danke!

Answer 1

Wenn die Methoden sind diejenigen, die direkt von $ _POST und nicht als Methodenargumente zu lesen, dann würde ich Anlehnen der @uses Tag in der Docblock Methode:

/** 
* My foo() method 
* @return void 
* @uses $_POST['bar'] directly 
*/ 
public function foo() 
{ 
    echo "I use ", $_POST['bar'], "... :-)"; 
} 

Eine weitere Option könnte die @global Tag sein :

/** 
* My bar() method 
* @return void 
* @global mixed uses the 'bar' key from the $_POST superglobal directly 
*/ 
public function foo() 
{ 
    global $_POST; 
    echo "I use ", $_POST['bar'], "... :-)"; 
} 

ich, dass die „globale“ realisieren Schlüsselwort für eine superglobalen in einem Verfahren technisch nicht notwendig, aber es dokumentiert hilft erhalten.

---

bearbeiten

Beachten Sie, dass PHPDoc Referenzhandbuch nach, ist @uses eine Zwei-Wege-Beziehung zeigen soll.

Dokumentation Generatoren sollte ein @ verwendet-für-Tag in der Dokumentation des Empfangselements erstellen, die mit dem @uses Tag

So assoziiert mit dem Element verbindet zurück, obwohl semantisch @uses besser lesen kann , @see könnte auch verwendet werden, um einen Parameter $ _ [POST | GET | REQUEST] zu dokumentieren. Der hauptsächliche/einzige Unterschied zwischen den beiden ist, dass @see eine Einwegverbindung zur FQSEN sein soll, die im Doc-Block