phpdocumentor - plantilla para documentar codigo
La mejor manera de documentar(phpdoc) los generadores(métodos que producen) (3)
A efectos prácticos, obtener un valor significa devolver una matriz de valores. Por lo tanto, lo más beneficioso sería especificar una matriz de tipos específicos como valor de retorno.
Como se señaló en los comentarios, hay advertencias , pero tener una terminación de tipo de trabajo supera a las de mi mente. Por lo tanto, desde el punto de vista de la usabilidad, no veo una mejor manera de hacerlo hasta que esto se resuelva en el sentido ascendente .
Cuál es la mejor manera de documentar, para phpdocumentor2, un método que es un generador.
No creo que @return realmente funcione para el yield , pero parece que no puedo encontrar una alternativa adecuada.
¿Es solo una cuestión de esperar a que phpdoc se ponga al día?
Fui con @return Generator|SomeObject[] , donde SomeObject es la cosa que se está cediendo.
PhpStorm también maneja esto bien, ya que ahora normalmente insinúa los métodos del Generator y cuando SomeObject insinúa SomeObject métodos de SomeObject .
(Aun así, preferiría un @yield nativo).
Cuando se llama a una función de generador por primera vez, se devuelve un objeto de la clase Generador interna.
Por lo tanto, estrictamente hablando, @return Generator sería correcto, aunque no es muy descriptivo de lo que puede esperar recuperar cuando se itera sobre el generador.