none
Documentacion de Software

    Question

  • A medida que voy escribiendo codigo escribo la documentacion de la misma, pero lo que no se es con que programa se ve eso luego.

    Quiero saber como es y en que consiste esa etapa...la documentacion, alguien puede pasarme algun link y programas que se utilizan?

    Gracias

    Saturday, January 20, 2007 2:47 AM

All replies

  • SandCastle......

    sucesor de NDoc como herramienta de documentacion.

    no recuerdo la direccion, pero es una herramienta de microsoft asi que si buscas en google saldra la direccion para bajarlo.

    hay tambien una GUI para sandcastle que ayuda mucho, pk es por linea de comandos originalmente.
    SandCastle Help File Builder se llama.

    Saludos.
    Saturday, January 20, 2007 6:28 PM
  • Hola Estela,  SandCastle se ha movido a CodePlex, su nueva dirección es

    http://www.codeplex.com/SHFB

    También te recomiendo que pruebes GhostDoc. Es un pequeño add-in para VS que te ayuda a escribir los comentarios.

    http://www.roland-weigelt.de/ghostdoc/


    Saludos


    --------------------
    J. Marcos Troncoso
    Cochabamba - Bolivia


    Monday, January 22, 2007 2:49 PM
  • Hola

    Gracias por los link que me pasaron, pero tal vez no me exprese bien. Para mi el software terminaba en las pruebas, nunca realice documentacion del mismo. Aprendi como escribir xml en el codigo que seria lo que se utiliza a posterior para la documentacion.

    Mi duda es.......que se hace con esa informacion xml???, como se la muestra cuando se vende un programa. Digamos que la parte de la escritura xml la entiendo, pero no se y la verdad nunca vi como es utilizada esa informacion externamente a done se encuentra escrita. Me explico?

    Gracias

    Digo yo.....seria como un archivo de ayuda o algo asi?????

    Monday, January 22, 2007 6:29 PM
  • Parace que no salio lo que conteste.......  :(

    Tal vez no me exprese bien, pero lo que no entiendo es para que se utiliza esa informacion xml que uno escribe en el codigo. Seria como un archivo de ayuda para el cliente?.

    Se lo puede comparar con un archivo .hlp o chm ????????.

    Por les comento que aprendi a escribir xml pero no tengo la menor idea de como, luego de desarrollar la aplicacion es utilizada esa informacion xml.

    Gracias

    Monday, January 22, 2007 6:54 PM
  • Hola

    Por ahi no me exprese bien. Yo entiendo como escribir el xml que va en el codigo. Lo que me gustaria entender es luegoooo como y por quien es utilizado. Y obviamente ese xml como es visualizado.

     

    Seria algo asi como .hlp o un chm????

    Monday, January 22, 2007 7:41 PM
  • Hola otra vez Estela. Te expresaste muy claramente, y te entendimos muy bien tambien

    La Respuesta es la misma: SandCastle. Esta herramienta puede generar archivos chm, hxs o un sitio web a partir de los comentarios que hayas escrito. Para una descripción completa de sus características, dale una ojeada a su página web.

    Esta información luego es utilizada por tí misma o por otros programadores para entender el código y poder darle mantenimiento.

    Probablemente la sugerencia del GhostDoc que te di te haya confundido un poco. Esta herramienta es muy útil al momento de _escribir_ los comentarios, Probablemente en este proyecto ya no la necesites, pero te recomiendo que la pruebes en tus proyectos futuros.

    Bueno, espero haberte ayudado en algo, si necesitas algo mas, aquí estaremos


    --------------------
    J. Marcos Troncoso
    Cochabamba - Bolivia

    Monday, January 22, 2007 10:22 PM
  • mira un pequeñ articulo de introducción a SandCastle que escribi gracias a que un compañero de trabajo nos presento esta herramienta.

    puedes ver el articulo en mi blog http://fdaines.blogspot.com



    o bajarlo desde aqui

    Saludos y espero ser de ayuda.

    Francisco.
    Thursday, February 01, 2007 3:47 PM
  • Por cierto, muy buen artículo Francisco, voy a darles una mirada a los demás, seguro serán de gran interés como este de SandCastle.

    Saludos

    --------------------
    J. Marcos Troncoso
    Cochabamba - Bolivia
    Thursday, February 01, 2007 7:08 PM
  • buenas...me parece que lo que esta preguntando es otra cosa...no con que se generan los archivos de ayuda sino que es lo que ocurre con los comentarios que estan escritos en el codigo fuente del programa no??

    yo tengo entendido que todo lo que no sea codigo ejecutable(comentarios y demas) al compilar el codigo se borran y no quedan en el ejecutable...los comentarios que se pueden insertar en el codigo son para ayudar al progrogramador a aclarar su propio codigo fuente...una vez que compiles la aplicacion esa "documentacion" desaparece...


    Wednesday, February 07, 2007 6:10 PM
  • Ante todo un saludo cordial a toda la comunidad de desarrolladores ,yo estoy migrando del vs 2003 a el 2005 pero algo ya estube viendo respecto a tu pregunta ,que tal estela  mira si bien tengo entendido en la msdn que esta acompañado al visual estudio 2005  tenes la explicacion como generar los archivos help y en que lenguaje generarlos ya sea como xml como web service o para tu site dinamico igual en el momento de compilar tambien tenes la opcion si mal no lo recuerdo eso lo haces desde el menu de la barra de herramientas del proyecto bueno espero que te halla servido de algo mi post saludos cordiales By_Diablo
    Sunday, April 01, 2007 10:40 AM
  • Para todos mirar esta pequeña herramienta para documentar código:

     

    http://www.roland-weigelt.de/ghostdoc/

     

    Salu2

    Monday, April 02, 2007 7:20 AM