Foros del Web » Programando para Internet » PHP »

¿Cuales son las maneras más correctas de documentar un programa?

Estas en el tema de ¿Cuales son las maneras más correctas de documentar un programa? en el foro de PHP en Foros del Web. En mi camino de aprender a programar siempre he tenido la sensación de que la forma de documentar un programa queda en manos de la ...
  #1 (permalink)  
Antiguo 20/05/2014, 11:31
Avatar de guardarmicorreo  
Fecha de Ingreso: noviembre-2012
Ubicación: Córdoba
Mensajes: 1.153
Antigüedad: 7 años, 1 mes
Puntos: 84
¿Cuales son las maneras más correctas de documentar un programa?

En mi camino de aprender a programar siempre he tenido la sensación de que la forma de documentar un programa queda en manos de la subjetividad.

He visto código nada documentado, código con un simple comentario sobre una propiedad sin indicar nada de ella, simplemente lo que hace y por mi parte trato de especificar qué hace una clase, qué hace un método, lo que devuelve y cuales son sus parámetros.

En PHP ¿cuales o cual es la manera más correcta de documentar un programa?
__________________
Ayúdame a hacerlo por mi mismo.
  #2 (permalink)  
Antiguo 20/05/2014, 11:43
Avatar de pateketrueke
Modernizr
 
Fecha de Ingreso: abril-2008
Ubicación: Mexihco-Tenochtitlan
Mensajes: 26.399
Antigüedad: 11 años, 8 meses
Puntos: 2534
Respuesta: ¿Cuales son las maneras más correctas de documentar un programa?

Consulta acá: http://www.phptherightway.com/
__________________
Y U NO RTFM? щ(ºдºщ)

No atiendo por MP nada que no sea personal.
  #3 (permalink)  
Antiguo 20/05/2014, 11:50
Avatar de guardarmicorreo  
Fecha de Ingreso: noviembre-2012
Ubicación: Córdoba
Mensajes: 1.153
Antigüedad: 7 años, 1 mes
Puntos: 84
Respuesta: ¿Cuales son las maneras más correctas de documentar un programa?

Gracias pateketrueke!

No encuentro el apartado donde habla sobre buenas prácticas para documentar un programa :S
__________________
Ayúdame a hacerlo por mi mismo.

Etiquetas: documentar, son
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta

SíEste tema le ha gustado a 1 personas




La zona horaria es GMT -6. Ahora son las 15:54.