Nueva pregunta

Pregunta:

Fecha: 29-07-2015 13:16:34 (En Español)

PhpDocumentor[Resuelta]

Buenas Tardes:
¿Alguien usa PhpDocumentor, y si lo usa sabe como instalarlo en wamp?
Etiquetas: PEAR - PHP - PHPDoc - PhpDocumentor - Pregunta Votos: 1 - Respuestas: 11 - Vistas: 19 Compartir en: Google Facebook Twitter LinkedIn Link
 

Respuestas:

  • Fecha: 29-07-2015 13:46:59 Link al sitio oficial de PhpDocumentor: http://www.phpdoc.org/

    Video explicativo de como implementarlo con Netbeans:

    Generating PHP Documentation with NetBeans IDE




    Saludos,
    Fernando
      Votos: 2 - Link respuesta
     
  • Fecha: 29-07-2015 13:47:32 Desconozco el uso de PhpDocumentor
    Pero te dejo este video a ver si te sirve

    Generar documentación phpDocumentor - YouTube




    Algunos links

    Documenta tus proyectos de PHP con PHPDocumentor

    Instalar phpDocumentor

    Espero que te sirva de algo
    Saludos
      Votos: 2 - Link respuesta
     
  • Fecha: 29-07-2015 15:01:17 Buenas noches:
    Muchas gracias a ambos, ya comienzo a experimentar, dejo la pregunta abierta, por si tengo que reepreguntar algo.
    Walter, con respecto a tus dichos ... "Desconozco el uso de PhpDocumentor"..., y teniendo en cuenta que a ambos nos interesa PHP5 POO - MySQLI, te recomiendo que comiences a darle importancia, ya que alguna vez te va a pasar el hecho de tocar un desarrollo tuyo despues de mucho tiempo y te vas a ahorrar muchos dolores de cabeza, si tenes el desarrollo documentado.
    Para finalizar, estoy leyendo y practicando mucho sobre PHP5 POO - MySQLI, asi que cuando quieran arrancar con las jornadas o encuentros sobre PHP5 POO, ya voy tener las maletas bien cargadas de dudas para preguntar a gusto ...
    Un saludo para ambos y gracias nuevamente.
      Votos: 2 - Link respuesta
     
  • Fecha: 29-07-2015 16:08:20 Daniel
    Estoy pasando mucho tiempo en aprender sobre POO, PDO

    Anoche hice una pegunta en el Grupo sobre POO
    Y una de las respuesta de un integrante ha sido interesante, tal vez te sirva para investigar Traits

    Espero que en algun momento se haga una coneferencia

    Saludos
      Votos: 2 - Link respuesta
     
  • Fecha: 29-07-2015 16:14:01 Voy a mirar el video que publico Fernando   Votos: 0 - Link respuesta
     
  • Fecha: 30-07-2015 11:28:28 Daniel

    Encontré un video interesante sobre Traits de PHP POO lo comparto

    PHP Avanzado - Traits


      Votos: 2 - Link respuesta
     
  • Fecha: 04-08-2015 10:30:56 De hecho PHPDoc tiene mucho que ver con un tema que poco se discute pero es relevante:
    Los comentarios.
    Un código se debe de documentar siempre, es prte de las buenas prácticas. Simplificas mucho ciertas tareas.
    Entre las mejores prácticas están:
    1. Que tu código se autodocumente, es decir que los nombres de variables, propiedades, funciones, métodos, constantes, recursos, etc. Sean claros y entendibles. Muchas veces la nomenclatura ayuda (camel case es mi favorita).
    2. Buenos comentarios. Seguir las recomendaciones de PHPDoc te va a ayudar como no tienes idea. En IDEs como PHPStorm puedes generar automáticamente tus setters y getters de mejor manera si tus propiedades están correctamente documentadas. De hecho hay service locators que, a través de reflection, utilizan los comentarios para realizar Dependency Injection.

    Si tomas las prácticas de PHPDoc te vas a simplificar mucho la vida a futuro.
      Votos: 1 - Link respuesta
     
  • Fecha: 07-08-2015 07:50:49 Buenas tardes a todos:
    Luego de dar varias vueltas en circulo y no llegar a nada, opte por lo mas sencillo y muy util.
    En mi caso trabajo con Sublime Text 3, este tiene Plugin, que se llama DocBlockr.
    Este plugin nos permitirá crear documentación sobre el código fuente:

    Para instalarlo:
    .- CTRL+ Shift + P y tecleamos install y seleccionamos Package Control: Install Package.
    .- Escribimos docbl y en los resultados que aparezcan pulsamos en DocBlockr.
    .- Para probar su funcionamiento simplemente tendremos que escribir /** y pulsar TAB encima de una función.

    Un ejemplo de como queda al hacerlo funcionar de este modo:

    /**[TAB]
    function sumar(a,b)
    {
    	return a+b;
    }
     
    // Y obtendremos algo como:
    /**
     * [sumar description]
     * @param  {[type]} a
     * @param  {[type]} b
     * @return {[type]}
     */
    function sumar(a,b)
    {
    	return a+b;
    }
     
     
    // Tendremos que completar la documentación cubriendo cada apartado y pulsando [TAB] para pasar al siguiente.
    // Y generaremos un código similar al ejemplo siguiente:
    /**
     * Función que devuelve la suma de dos números pasados como parámetro.
     * @param  {number} a
     * @param  {number} b
     * @return {number}
     */
    function sumar(a,b)
    {
    	return a+b;
    }


    Por lo tanto, agradezco a todos su ayuda y les dejo esta alternativa si trabajan Sublime Text 2 o Sublime Text 3
      Votos: 0 - Link respuesta
     
  • Fecha: 07-08-2015 08:37:34 también escribiendo en Netbeans /** y presionando enter sobre el método de una clase se crea el comentario en formato phpdoc

    Saludos,
      Votos: 1 - Link respuesta
     
  • Fecha: 07-08-2015 09:05:36 Lo mismo sucede con PHPStorm y /**.
    De hecho puedes definir el contenido de tus comentarios para que el formato sea a tu gusto.
    Si no me equivoco Zend Studio también se comporta igual.
      Votos: 2 - Link respuesta
     
  • Fecha: 07-08-2015 09:35:44 Nuevamente gracia.
    Paso a dar por finalizada la pregunta como resuelta
      Votos: 0 - Link respuesta
     
Para participar activamente de la comunidad primero debes autenticarte, ingresa al sistema.Iniciar Sesión