none
Generar documentacion estilo javadoc RRS feed

  • Pregunta

  • Buenas

    Amigos tengo una aplicativo en c# y esta todo debidamente documentado el código y todo por el estilo, ahora lo que se plantea es realizar un tipo de guía tipo javadoc para la documentación, como todos los desarrolladores de .net, han visto la documentación de algunas librerias en las web oficiales de microsoft y la verdad quiero aplicar ese estilo, alguien podría asesorarme en como hacerlo y que herramientas podría utilizar 


    • Editado jhonny sierra miércoles, 22 de julio de 2020 2:00 No tiene acento el titulo, la tilde no la aprecia como se deberia
    miércoles, 22 de julio de 2020 1:56

Todas las respuestas

  • Lo primero cerciórate de que has escrito los comentarios XML en tu programa. Marca en las propiedades del proyecto la casilla para que se genere la documentación XML en disco al compilar.

    Para convertir esa documentación XML a un formato legible, tal como .hlp o .html, hay varias herramientas en las que puedes apoyarte. Por ejemplo, puedes usar Sandcastle:

    https://github.com/EWSoftware/SHFB

    que tiene la ventaja de que además de usar la documentación xml también usa Reflexión sobre los binarios para sacar información adicional y combinarla toda en la documentación producida.

    • Propuesto como respuesta Sergio Parra miércoles, 22 de julio de 2020 10:02
    miércoles, 22 de julio de 2020 7:17
  • hola

    Podrias evaluar extensiones del VS como ser

    VSdocman

    veo que esta extrae los comentarios del codigo armando el documento

    Tambien existe

    DocFX

    el cual genera la documentacion en static html

    saludos


    Leandro Tuttini

    Blog
    MVP Profile
    Buenos Aires
    Argentina



    miércoles, 22 de julio de 2020 13:50
  • Hola

    ¿Te han funcionado las respuestas? Si nos puedes actualizar tu estado, sería genial!

    Saludos

    lunes, 27 de julio de 2020 12:56
    Moderador