2009-07-26 14 views
10

Estoy desarrollando con Eclipse + PDT. He estado agregando comentarios phpdoc en mi código, , pero en realidad nunca he generado una documentación resultante en Eclipse. ¿Cómo debo hacerlo? ¿Hay alguna funcionalidad en Eclipse, o la generación de documentos debe hacerse externamente?generador de documentación PHPDoc dentro o fuera de Eclipse?

Respuesta

5

Para generar la documentación, debe usar phpDocumentor, que se puede instalar como un paquete PEAR.

Luego, tiene que llamarlo desde la línea de comandos; Nunca lo había visto llamar desde Eclipse PDT, en realidad.

Una gran solución es tener una plataforma de integración continua (usando phpUnderControl, por ejemplo), e integrar a la creación del phpdoc en su archivo de configuración de compilación; de esta manera, el phpdoc se genera cada vez que alguien comete (o una vez al día, o cuando quiera ^^).

En Eclipse PDT, puede llamar a "herramientas externas" (consulte "Ejecutar> Herramientas externas" en el menú); esto le permitiría iniciar el comando phpdoc (como lo hace desde CLI); pero definitivamente no es tan fácil de usar como lo que ofrece Zend Studio, tampoco el mismo precio, aunque ^^

+0

He usado hormiga para construir mis proyectos de php, y generalmente tengo un objetivo de doc. Eclipse juega muy bien con la hormiga. También corres phing desde eclipse. –

1

Sí, hay un asistente para hacer esto en Zend. Mira esto brief guide.

Como alternativa, puede crear una configuración de ejecución externa para invocar el estándar phpDocumentor.

  1. Seleccione Run-> Herramientas externas> Herramientas Configuraciones externos ...
  2. En el panel de la izquierda, seleccione el programa a continuación, el nuevo icono (más a la izquierda del icono situado encima del panel).
  3. En el panel de la derecha, seleccione la pestaña Principal.
  4. Ingrese generate_doc en el campo Nombre :.
  5. Ingrese la ruta a la herramienta phpdoc cli en el campo Ubicación :.
  6. Ingrese los argumentos necesarios en el campo Argumentos, p. para la entrada del proyecto actual $ {project_loc}.
  7. Para ejecutar la configuración externa, seleccione Ejecutar.

Para volver a ejecutar la configuración que tiene algunas opciones:

  1. seleccione el icono de herramientas externas de la barra de menú external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png" continuación, haga clic generate_doc
  2. Seleccione Run-> Herramientas externas> generate_doc
  3. Pulse Alt + R, E, 1 (suponiendo que generate_doc es el primer elemento de la lista, de lo contrario, elija el número apropiado)
+0

Gracias, pero estoy usando Eclipse + PDT regular, aparentemente no existe tal opción. – AlexA

2

Otra gran herramienta para generar documentación es ApiGen. No necesita instalación con PEAR (pero lo incluye) y se puede usar como un paquete independiente.

+0

¿Cómo instalamos 'ApiGen' para Windows?Descargué el paquete 'phar' pero no tengo ni idea de cómo proceder. –

+0

@SuhailGupta échale un vistazo aquí: https://github.com/ApiGen/ApiGen –

+0

Así que incluí la ruta 'C: \ wamp \ www \ apigen.phar' en la variable de usuario' PATH'y también dentro del 'System' Camino. ¡Pero no funciona! Simplemente no imprime nada. –

Cuestiones relacionadas