2010-04-29 12 views
8

Bien, estoy harto de phpDocumentator. Consume mucho más memoria (1,4 GB) y tiempo (5 minutos en el Core 2 Duo de 2,6 GHz) de lo que estoy dispuesto a darle. ¿Existe algún programa realmente compatible para generar documentación para el código PHP?phpDocumentor alternativa consume menos memoria

He intentado PHPDoctor, que se ve bien, pero tiene algunos missing features. Sin embargo, es probable que esté más cerca de ser el reemplazo de todas las soluciones que he probado hasta ahora.

También he intentado PhpDocGen, pero simplemente rescata con algunos errores de Perl, que soy demasiado perezoso para estudiar.

Doxygen también no parece jugar bien con nuestras fuentes.

PD: La documentación sería para phpMyAdmin, la documentación un poco obsoleta es here.

Actualización: El código contiene muchas funciones y no sólo los objetos, lo que es el mayor problema con Doxygen, porque no puede organizarlos.

+2

Fuera de interés, cómo la memoria intensiva es que para su proyecto específico? – Andy

+0

Se bloqueó con un límite de 1 GB y aún tenía muchos archivos por procesar. –

+0

mmm. En serio, no veo el problema. no es como si ejecuta PHPdocumentor las 24 horas del día. como dijiste, es un acuerdo de 5 minutos que es parte de tu proceso de construcción. – Stann

Respuesta

2

Doxygen es bastante compleja, y se supone que debe soportar PHP 5.3 características. Sin embargo, no funcionó exactamente como lo quería y me di cuenta de que es un gran programa, pero no está diseñado para PHP; así que necesitaba algo más ligero, simple y preferiblemente exclusivo de PHP, porque, reconozcámoslo, PHP no tiene la sintaxis y la apariencia del lenguaje de programación común.

Yo sé que usted ha mencionado, pero lo eligieron PHPDoctor al final. Sin embargo, carece de algunas características, pero es simple y rápido, exactamente lo que estaba buscando.

Indíquenos qué eligió y cuáles fueron las razones.

También algo que quiero mencionar es que encontré la interfaz PHPDoctor a ser bastante simple y fácil de peinar (con algunos cambios de estilo CSS). Pude crear una página bastante limpia para mis documentos.

1

He estado usando Natural Docs, funciona bien para mí

+0

Podría ser una buena opción, pero significaría convertir toda la documentación a un nuevo formato, que es un trabajo que me gustaría evitar. –

3

Nos cambiamos de phpDocumentor a Doxygen porque el primero no apoyó PHP 5.3 características como espacios de nombres y cierres. La última actualización de phpDocumentor fue en 2008.

Los principales atributos @ son los mismos en Doxygen, porque ambos hacen comentarios al estilo JavaDoc. Es bastante configurable, también.

+0

Veo varios problemas con Doxygen, pero tal vez solo no puedo configurarlo correctamente. No maneja los comentarios a nivel de archivo y crea un gran desorden en la documentación del espacio de nombres.No genera documentación para funciones a menos que 'EXTRACT_ALL' esté habilitado y todavía no proporciona una manera fácil de explorar funciones además de examinar archivos. Tampoco es compatible con @uses y @subpackage. –

+0

No usamos '@ subpackage' (eso es lo que hacen los espacios de nombres ahora) o' @ uses' (no lo usamos, hah). En cuanto a los comentarios a nivel de archivo: eso puede ser un problema, pero seguimos el enfoque de "una clase por archivo", así que solo usamos los comentarios de la clase. – janmoesen

+0

Tener solo clases haría las cosas probablemente más fáciles, pero todavía no es el caso (todavía). –

3

También puedes probar DocBlox; es un niño nuevo en el barrio (juego de palabras intencionado) pero ya admite muchas de las características que ofrece phpDocumentor y muchas de las cosas más nuevas (como espacios de nombres). Inténtelo hacia fuera en https://www.github.com/mvriel/Docblox

+0

Todavía se centra en código de objeto y clases, y es bastante inútil para el código que contiene principalmente funciones. Pruébelo en phpMyAdmin. –

+0

¿Qué tipo de organización tienes en mente? Aparentemente espera que las herramientas de generación de documentación agrupen de alguna manera estas funciones en secciones lógicas. Para clases y archivos, esto se hace por clase, espacio de nombres y la etiqueta @package en docblock. las funciones se agrupan generalmente en el nivel de archivo (que puede agrupar utilizando la etiqueta @package) –

+0

@Mike van Riel Me encanta Docblox. Lo uso con los comentarios que escribí para PHPDocumentor sin ningún cambio, y es genial. ¿Tiene interés en desarrollar una interfaz HTML? –

Cuestiones relacionadas