PHPDoc: Ist es möglich, die Objekteigenschaftsbeschreibungen vom Werksmethodendocblock aus zu referenzieren?

Question

Wenn ich eine Factory-Methode verwende, um Objekte zu instantiieren, ist es dann möglich, auf die Docblock-Beschreibungen der Klasseneigenschaften für die Objekte zu verweisen, die instanziiert werden?

Ich finde mich in die Klassen, um mich daran zu erinnern, welche Parameter die Fabrikmethode zu geben. Es wäre praktisch, wenn ich einfach alle relevanten Docblock-Beschreibungen von allen Objekten, die die Factory ausgibt, referenzieren könnte, dann würde meine IDE mich auffordern, wenn ich die Factory-Methode anrufe.

Answer 1

Für das Szenario, das Sie beschreiben, ist der beste Pfad, den ich sehen kann, dass all diese potentiellen Klassen die gleiche Schnittstelle implementieren oder sich vielleicht von derselben abstrakten Elternklasse erstrecken. Verwenden Sie dann @return für die Factory-Methode, um anzugeben, dass ein Objekt dieser Schnittstelle/Zusammenfassung zurückgegeben wird. Auf diese Weise könnte die IDE die Docblocks aus dem Code der Schnittstelle/Zusammenfassung lesen und Informationen an Sie weitergeben.