09/11/2012, 20:08
| ||||
| ||||
 <¿Cómo documentar un código? Hola que tal chicos! Mi pregunta espero no suene tonta, lo que pasa es que estoy trabajando en un proyecto, y se necesita un Manual Técnico. Así que de acuerdo a su experiencia, cuál sería la mejor forma de documentar el código, ¿en WORD? o existen alternativas visuales más actractivas de presentarle al cliente final con el código correspondiente. Saludos!!! ¿me ayudan?
__________________ "La verdadera clave de la grandeza es ser en verdad lo que aparentamos ser" -Sócrates |
|
10/11/2012, 10:36
| ||||
| ||||
| Respuesta: <¿Cómo documentar un código? 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 PEAR. Si quieres saber más, puedes leer un artículo que escribí sobre ello hace poco en http://rubenmartin.me/2012/phpdoc-el...e-comentarios/. Después se suele procesar con PHPdoc para crear una API, e incluso algunos IDEs saben leer esos comentarios.
__________________ Freelance Developer — www.rubenmartin.me PHP, SQL, Wordpress, Prestashop, Codeigniter, Laravel RegaloConsolas — www.regaloconsolas.com Sorteo juegos, consolas y accesorios |
|
12/11/2012, 08:27
| ||||
| ||||
| Respuesta: <¿Cómo documentar un código? Cita: Pero necesito pegar un código para imprimirlo y quería saber cual es la mejor forma para presentarlo, ya que no quiero solamente pegar y copiar a un documento de Word, ¿hay otra manera mejor de presentar ese código? Saludos!
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. 
__________________ "La verdadera clave de la grandeza es ser en verdad lo que aparentamos ser" -Sócrates |
|
12/11/2012, 08:35
| ||||
| ||||
| Respuesta: <¿Cómo documentar un código? Cita: 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!
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. 
__________________ "La verdadera clave de la grandeza es ser en verdad lo que aparentamos ser" -Sócrates |
| Etiquetas: |
