Pregunta:
¿Qué herramienta puede generar documentación HTML a partir del código C #, como Javadoc puede hacer para Java?
Nicolas Raoul
2014-02-05 06:47:08 UTC
view on stackexchange narkive permalink

Los desarrolladores de Java pueden generar fácilmente documentación HTML a partir de su código Java, que es una forma conveniente de publicar API en línea. Este es un ejemplo.

¿Existe una herramienta similar para el código C #?

Debe ser gratuito, idealmente de código abierto.

Debe ejecutarse en Windows y Linux, al menos.

No se necesitan marcos HTML, herramientas que generan solo una página HTML larga también es perfecta.

Usamos [Sandcastle Help File Builder (SHFB)] (https://github.com/EWSoftware/SHFB). Es potente y gratuito, puede generar tanto ayuda .chm como html.
Cuatro respuestas:
#1
+16
aman207
2014-02-05 07:10:12 UTC
view on stackexchange narkive permalink

Doxygen parece lo que funcionaría para usted.

  • Puede generar un navegador de documentación en línea (en HTML) y / o un -line manual de referencia (en $ \ mbox {\ LaTeX} $) de un conjunto de archivos fuente documentados.
  • También hay soporte para generar resultados en RTF (MS-Word), PostScript, PDF con hipervínculos, HTML comprimido y páginas de manual de Unix.
  • La documentación se extrae directamente de las fuentes, lo que hace que sea mucho más fácil mantener la documentación consistente con el código fuente.

Se puede usar para generar documentación desde C #, junto con otros lenguajes como C, Objective-C, PHP, Java, Python.

Acabo de probar Doxygen, funciona como un encanto, ¡muchas gracias!
#2
+16
Lyndon White
2014-02-05 12:29:56 UTC
view on stackexchange narkive permalink

Puede hacer esto con el compilador normal de Microsoft C #. Aunque no es de código abierto. Debate es gratis, ya que usa herramientas que ya tienes.

Para el archivo C # llamado XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

producirá el archivo xml XMLsample.xml . Al aplicar una hoja de estilo a esto, tendrá un buen sitio web. CSS debería funcionar, aunque para un reformateo más significativo es posible que deba usar XSLT.

vea MSDN


También está disponible en Mono C # compilador. Mono C # es gratuito y de código abierto.

  mcs XMLsample.cs /doc:XMLsample.xml  

Ver Página de manual de Mono

Esto no puede generar la documentación de un archivo C # sin el método Main (). ¿Hay algún otro comando para ello?
Las preguntas de @Riky sobre el uso de software se adaptan mejor al superusuario, o en este caso, stackoverflow
#3
+5
xpt
2017-02-28 02:54:20 UTC
view on stackexchange narkive permalink

Poniendo mi 2c porque estaba siguiendo la respuesta aceptada, pero resulta que

El compilador de Microsoft C # solo está haciendo un trabajo a medias. Es decir, solo le da un archivo xml. Pero para tener un buen sitio web, aún tendrá que aplicarle una hoja de estilo, y ahí es donde se rompe el puente: el compilador de Microsoft C # no hace eso, y las herramientas compatibles de Microsoft que lo hacen, Sandcastle El proyecto CodePlex ya no está en desarrollo activo por parte de Microsoft.

En general, la respuesta aceptada puede ser buena para el año 2014, pero ya no es buena para 2017.

La nueva respuesta es Sandcastle Help File Builder strong de Eric Woodruff > sitio en https://GitHub.com/EWSoftware/SHFB, que está bifurcado y se basa en el código fuente existente de Sandcastle.

#4
+2
David Thielen
2014-07-30 19:51:36 UTC
view on stackexchange narkive permalink

Usamos Documento! X y nos funciona muy bien. Obtienes los documentos API completos de los comentarios y las hojas de estilo hacen que se vea muy, muy bien. También son muy receptivos con el soporte.

Dicho esto, no es gratis. Pero por lo que ofrece, creo que vale la pena. (Anteriormente usábamos un programa gratuito, no doxygen, y resultó ser demasiado caro en términos de cuánto tiempo tomó).



Esta pregunta y respuesta fue traducida automáticamente del idioma inglés.El contenido original está disponible en stackexchange, a quien agradecemos la licencia cc by-sa 3.0 bajo la que se distribuye.
Loading...