12/11/2012, 08:35
|
 | | | Fecha de Ingreso: noviembre-2012 Ubicación: Torreón
Mensajes: 54
Antigüedad: 12 años Puntos: 0 | |
| Respuesta: <¿Cómo documentar un código?
Cita:
Iniciado por hasdpk  Una de las cosas que se hacen es seguir un estándar en los comentarios, que si ya has trabajado con scripts o snippets lo habrás visto.
El estándar que se sigue para los comentarios es el de [url=http://pear.php.net/manual/en/standards.header.php]PEAR[/url]. Si quieres saber más, puedes leer un artículo que escribí sobre ello hace poco en [url]http://rubenmartin.me/2012/phpdoc-el-estandar-de-comentarios/[/url].
Después se suele procesar con [url=http://phpdoc.org]PHPdoc[/url] para crear una API, e incluso algunos IDEs saben leer esos comentarios. Me gustó tu idea!! Existe algun tutorial para hacer funcionar lo de phpDocumentor, te lo agradecería! Aunque también mi idea iba a tener el código impreso y cual sería la mejor forma, pero esta idea también me guto!
__________________
"La verdadera clave de la grandeza es ser en verdad lo que aparentamos ser" -Sócrates |