18 Stimmen

Gibt es einen Standard für die Dokumentation von GET/POST-Parametern?

In einem PHP-Projekt kann es, selbst wenn die Front-Controller-Logik für die Hauptanwendung verwendet wird, viele eigenständige Skripte, Ajax-Snippets usw. geben.

Gibt es einen standardisierten Weg - entweder PHPDoc oder etwas anderes - um im ersten Kommentarblock des Skripts zu definieren, welche GET- und/oder POST-Parameter das Skript akzeptiert / benötigt und von welchem Typ sie sind?

Normalerweise helfe ich mir selbst, indem ich einfach Folgendes hinzufüge @param s, als ob die Datei eine Funktion wäre, und eine @return Erklärung für das, was das Skript tut und zurückgibt, aber vielleicht gibt es einen spezielleren Weg, den ich nicht kenne.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X