phpdoc

Por lo tanto, en PHPDoc se puede especificar @var por encima de la declaración de la variable miembro para indicar su tipo. E ... able miembro es una matriz de SomeObjs? @var array no es suficiente, y @var array(SomeObj) no parece ser válido, por ejemplo.

Solo una pregunta rápida: He visto que algunas funciones PHP se comentan en la parte superior, utilizando un formato que es d ... cluirá el símbolo @ en su búsqueda. ¿Qué es este formato de comentario y dónde puedo encontrar alguna información sobre él?

¿Es realmente necesario hacer algo como esto: /** * ... * * @return void */ Tengo bastantes métodos que no tienen u ... retorno, y parece realmente redundante poner algo como esto en el comentario. ¿Sería considerado de mala forma dejarlo fuera?

Solo curiosidad si hay una manera en netbeans para dar consejos de tipo para las variables regulares, de modo que intellisens ... usar afterward SomeService después, netbeans proporcionaría todos los métodos disponibles definidos en la clase Some_Service.

Tengo este código: /** * Days to parse * @var int */ const DAYS_TO_PARSE = 10; ... No creo que usar @var sea correcto para una constante y no veo ninguna etiqueta PHPDoc @constant. ¿Cuál es la forma correcta de hacer esto?

Estoy luchando para escribir documentación legible y fácil de entender que describe la estructura multi-árbol para las opcion ... Además, no estoy seguro de que lo anterior explique claramente la estructura de la matriz. ¿Existe un enfoque alternativo?

Tengo un método que devuelve el objeto actual, ¿cómo puedo documentar esto? /** * set something * * @return this */ publ ... function setSomething(){ // ... return $this; } O debería hacer @return self o @return Current_Class_Name?

Tengo un método que extrae un árbol transversal de preorden modificado de la base de datos, y lo filtra usando una función de ... si eso es correcto. También, cualquier otro comentario sobre la calidad (o falta de ella) en este código sería apreciado:)

¿Cuál es la forma más útil/más estándar/menos sorprendente de escribir bloques de comentarios consistentemente para construc ... uiero intentar evitar, en la medida de lo posible, la repetición entre bloques de clase, constructor y comentario de archivo.

Tengo varios proyectos PHP antiguos terminados con muchas inclusiones que me gustaría documentar en el estilo javadoc/phpDocu ... que una herramienta C/Java podría ser capaz de manejar archivos PHP después de algunos ajustes. Gracias por su gran entrada!

Por lo que he investigado, parece que no puedo encontrar un método correcto para formatear una línea phpdoc @param multilínea ... } echo $string; } ¿Sería eso correcto, o no agregaría sangría, o simplemente mantendría todo en una línea larga?

Estoy usando Eclipse PDT y quiero anotar una variable local usando Phpdoc. Todo lo que veo es que puedo anotar las variables ... ible para una variable local? ¿Cómo puedo hacer algo como esto? function foo(){ /** @var Stock $a */ $a->save(); }

O es solo en un estado 'terminado'? He usado PHPDoc durante muchos años en todos mis proyectos PHP, pero recientemente noté ... na llamada *ACTUALIZACIÓN: Resulta que DocBlox es PHPDocumentor2 disfrazado/renombrado. http://www.docblox-project.org /