1. Inicio
  2. Pregunta y respuesta
  3. ¿Algún tutorial sobre cómo usar phpDocumentor?

¿Algún tutorial sobre cómo usar phpDocumentor?

2009-12-02 92 views
21

Quiero comenzar a utilizar phpDocumentor pero me resulta difícil: la interfaz web no funciona bien y no puedo ver los archivos de ejemplo¿Algún tutorial sobre cómo usar phpDocumentor?

Probablemente no lo configuré correctamente y Me gustaría un buen tutorial paso a paso (es decir, NOT THIS ONE) para comprobar dónde me he equivocado y espero obtenerlo analizando algo

Pero no puedo encontrar nada a través de google. ¿Alguien puede sugerir algún buen tutorial o recursos para comenzar con phpdoc?

¡Muchas gracias!

Ian

EDIT: Gracias por saltar, ashnazg! Estos fueron los pasos que hemos seguido:

  1. pera no funcionaba en mi Mac versión 1.4.3 por lo descargado y descomprimido en un directorio especificado
  2. la ruta absoluta al archivo de la muestra 2 en mi HD en la pestaña archivo
  3. Se especificó una carpeta de salida que se podía escribir en el mundo
  4. Se hizo clic en Crear ... cosas que están sucediendo en el registro, carpeta multimedia creada pero no informe. Log concluye "ERROR: nada analizado"

Desde que obtuve Pear trabajando e instalé phpdoc de esa manera; puede usarlo a través de la línea de comandos, pero ¿hay alguna idea sobre qué podría pasar con la interfaz web para evitar que analice el archivo? Parece ser feliz en todos los demás aspectos.

EDIT 2: Gracias por el enlace a la Developer.com article, Liz: Es muy básico, pero un inicio rápido útil.

Fuente

2009-12-02 Polsonby

+0

Secundado. He estado escribiendo el código de phpDoc friendly por más de un año, pero nunca he conseguido que la maldita cosa funcione correctamente. También estaría muy agradecido por un buen tutorial paso a paso. La interfaz web y la documentación dejan mucho que desear. –

+0

ERROR: nada analizado ===> necesita especificar la ruta de la exploración -d ./ C: \ xampp \ htdocs \ mi_proyecto> phpdoc -o HTML: marcos: earthli, PDF: predeterminado: predeterminado -t ./docs -d ./ – websky

Respuesta

-1

Google es tu amigo :)

aquí está uno: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html

Fuente

2009-12-02 16:40:40

+2

Eso es extraordinariamente inútil, si lees la pregunta que hice, esa es la misma a la que me he vinculado. El punto es que las instrucciones allí no funcionan para mí y pedí OTROS tutoriales. – Polsonby

+0

Tiene razón, le di la respuesta incorrecta. ¿Esto ayuda? http://www.developer.com/lang/php/article.php/10941_3440261_2/Documenting-PHP-Code-with-PHPDocumentor.htm –

+0

Gracias por eso; sí, lo encontré usando Google también :) Pero es bastante bueno. – Polsonby

0

No estoy al tanto de cualquier tutoriales en relación con el uso de la interfaz web. En realidad, no recibo tantas preguntas para ayudarme a usarlo. Si puede destacar cómo lo está usando sin éxito, podría ayudarlo.

Fuente

2009-12-03 11:42:37 ashnazg

+0

Gracias por eso, agregué alguna explicación a mi publicación anterior – Polsonby

+0

"ERROR: nada analizado" indica que phpDocumentor no cree que le hayas dado ningún archivo PHP para procesar. Eche un vistazo más de cerca a la salida del tiempo de ejecución, y vea si detecta dónde intenta usar la ruta absoluta que le asignó. Mi primera corazonada podría ser que contiene una carpeta con un espacio en su nombre ... que _might_ podría estar causando un problema. – ashnazg

1

Personalmente, utilizo las etiquetas estándar de JavaDoc y un pequeño programa de Python para convertir mi PHP en archivos Java (con cuerpos de métodos vacíos). Luego ejecuto JavaDoc: me gustan las funciones y su aspecto mucho mejor que cualquier otra cosa que haya visto. Bueno, comencé con Java antes de PHP.

Este pequeño programa Python es parte de mis cosas PHP y se puede encontrar en

http://code.google.com/p/mcrwebapp/source/browse/trunk/tools/php2java

(por lo que vale la pena.)

Fuente

2009-12-07 05:29:25 Don

+0

Don muy interesante, JavaDoc siempre ha sido mi favorito. No es que sea una tarea enorme, pero ¿te importaría compartir tu programa de Python para convertir el PHP en un esqueleto de Java? – defines

5

La documentación no te dice esto, pero hay que mover la muestra archivos en un directorio que no tiene la cadena "tutorial" en ninguna parte de la ruta. phpDocumentor trata el "tutorial" como una palabra reservada y se niega a analizar los archivos que lo tienen en la ruta.

Fuente

2010-11-02 19:28:49 phenry

Cuestiones relacionadas

 Cuestiones relacionadas