¿Cuál es el estado de PHPDoc?

Nunca me importó mucho documentar mi código antes, pero recientemente comencé a trabajar en un proyecto de código abierto y surgió la necesidad. Obviamente, el "arma de elección" es PHPDoc, pero ...¿Cuál es el estado de PHPDoc?

No pude encontrar una sola especificación del estándar PHPDoc. Hay una entrada en la wikipedia que enumera algunas de las propiedades y está el proyecto phpDocumentor, que supuestamente tiene un diccionario más extenso, pero lo que me desconcierta es ¿dónde está la guía definitiva de PHPDoc? ¿Existe un estándar único o depende de todas esas imitaciones de phpDocumentor para extender el PHPDoc "estándar" (si existe) a lo que parezca? ajustarse.

Si asumimos que phpDocumentor es el lugar donde se crea y mantiene el estándar PHPDoc, las cosas se ven bastante deprimente, ya que the project's website está muerto para durante unos casi 4 años. y lo que me aún más extraña es que alrededor de un Hace un mes una versión 1.4.4 apareció repentinamente de entre los muertos en el sitio Pear de phpDocumentor.

Sé que hay muchos más inteligentes y expertos por aquí, por lo que me gustaría saber. ¿Cuál es el trato con PHPDoc? ¿Hay una sola autoridad que crea el estándar? ¿Qué tan confiable es? ¿Hay alguna futuro o nos enfrentamos a un zombi y toda esperanza está perdida ...

Gracias, Ivo

Fuente

2012-01-02 Ivo Sabev

no es una pregunta para el desbordamiento de la pila –

@Dagon - Me gustaría diferir. Se enmarca en ["problemas prácticos que se pueden responder y que son exclusivos de la profesión de programación"] (http://stackoverflow.com/faq). –

Como referencia, un sitio que no se actualiza en un momento no hace que el sitio (o el proyecto, para el caso) "muerto". Puede ser que una nueva versión no se haya * necesitado * durante más de 3 años, porque el software hace lo suyo y lo hace bien. – cHao

Esta pregunta ya es un poco antigua, pero por el bien de la información, debo agregar que DocBlox se fusionó con PhpDocumentor.

anunciar phpDocumentor 2 - la fusión de la antigua (phpDocumentor) y el nuevo (DocBlox).

Con la primera versión alfa de phpDocumentor (2.0.0a1), la nueva plantilla predeterminada “Responsive” Deportes de un nuevo diseño de la página, junto con los mejoras de diseño de útiles que las plantillas DocBlox originales proporcionaron (que permanecen disponibles) sobre las viejas plantillas de phpDocumentor (que se retirará con el viejo phpDocumentor). Explore esta nueva plantilla en http://demo.phpdoc.org/Responsive/index.html.

=>http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/

PHPDoc está de vuelta a la acción. =)

Fuente

2012-09-11 13:19:58 JCM

Según Wikipedia it's dead.

Las especificaciones para el estándar de etiquetas PhpDoc solían ser las que figuraban en la documentación de PhpDocumentor. Pero como dije, está muerto. Como DocBlox parece estar llenando el vacío que dejó PhpDocumentor, le aconsejo usar el DocBlox documentation como la base de cómo hace sus comentarios de PhpDoc.

Espero Netbeans 7.1 presentará compatibilidad con DocBlox porque es mucho mejor. Es consciente de PHP 5.3 y se mantiene activamente.

Fuente

2012-01-02 10:40:06 GordonM

Gracias por su comentario. Soy consciente de la gran cantidad de generadores de doc que existen, pero todos parecen extenderse en la base de PHPDoc, por lo que secretamente esperaba que hubiera un solo estándar, pero creo que tal vez no. Mi opción personal de generador por ahora es - http://apigen.org –

Si todos parecen extender phpDoc ... bueno ... eso debería decirte algo. A saber, there * is * one estándar principal para los comentarios del doc. El sistema que use puede cambiar, pero los comentarios serán prácticamente los mismos. – cHao

Envié un correo electrónico a algunos desarrolladores de phpdocumentor, quienes me informaron que el proyecto no está 'muerto', pero no se mejorará para obtener características de php 5.3 (el artículo de wikipedia también se actualizó en consecuencia y ya no incluye el proyecto como descontinuado) . Estoy de acuerdo con @IvoSabev, apigen es mi nuevo favorito personal. – William

A partir de agosto de 2013, el PHP Framework Interoperability Group comenzó a escribir una especificación formal (PSR) para PHPDoc. El estándar propuesto para PHPDoc, borrador actual PSR5: https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

El borrador actual actualiza la especificación para abordar PHP 5.3+, así como otros cambios que se han producido.Creo que la expectativa es que este estándar para los comentarios de PHP se adoptará a través de múltiples generadores de documentos.

Fuente

2014-08-31 22:14:46 Amgine

Respuesta

Cuestiones relacionadas