elhacker.net cabecera Bienvenido(a), Visitante. Por favor Ingresar o Registrarse
¿Perdiste tu email de activación?.
 
Inicio Ayuda Buscar Ingresar Registrarse
28 Mayo 2012, 21:33  


Tema destacado: Recuperar cuenta de Google, GMail, Youtube

+  Foro de elhacker.net
|-+  Programación
| |-+  Programación General (Moderador: Littlehorse)
| | |-+  Ayudenme:Documentar programas
0 Usuarios y 1 Visitante están viendo este tema.
Páginas: [1] Ir Abajo Respuesta Imprimir
Autor Tema: Ayudenme:Documentar programas  (Leído 792 veces)
Draco Heroicus


Desconectado Desconectado

Mensajes: 300


Ver Perfil
Ayudenme:Documentar programas
« en: 4 Diciembre 2008, 02:29 »

 ;D Hola que tal, quisiera que me den algo de orentación, requiero documentar un proyecto de la escuela (Un programa que hize), con documentar no me refiero a comentar el codigo si no a documentar todo como programa, alguno de ustedes me podra ayudar con una posible estructura de documentación, estuve viendo las manpages y la verdad no me gusto mucho ese estilo


En línea
Amerikano|Cls


Desconectado Desconectado

Mensajes: 783


[Beyond This Life]


Ver Perfil WWW
Re: Ayudenme:Documentar programas
« Respuesta #1 en: 4 Diciembre 2008, 17:10 »

Nosotros en la U utilizamos java y alli la documentación se basa a traves del javadoc, es decir son unas etiquetas que van en comentarios en las cuales pones  lo que hara el code, y esto generara un html con toda la info que pusiste.

@author, @deprecated, @param, @return, @version y otras mas son las etiquetas usadas para documentar, es decir pones en la etiqueta correspondiente por ejemplo en @author ahi va el autor del code, y bueno así es el caso para java, te dejo un link de wikipedia que muestra mas detalles  :P.

http://es.wikipedia.org/wiki/Javadoc

salu2 y espero te sirva de algo.

amerikano


En línea





Mi blog:
http://amerikanocls.blogspot.com
Draco Heroicus


Desconectado Desconectado

Mensajes: 300


Ver Perfil
Re: Ayudenme:Documentar programas
« Respuesta #2 en: 4 Diciembre 2008, 21:50 »

 :( Que mal xD estoy usando ASM pero nunca se me ocurrio ver la estructura de los Java Doc
En línea
Páginas: [1] Ir Arriba Respuesta Imprimir 

Ir a:  

Mensajes similares
Asunto Iniciado por Respuestas Vistas Último mensaje
Documentar atributos usando componentModel
.NET
Zeroql 0 151 Último mensaje 27 Enero 2012, 20:51
por Zeroql
Powered by SMF 1.1.16 | SMF © 2006-2008, Simple Machines