¿Cuál es la mejor manera de documentar el código F#?

Question

He probado Sandcastle con los parches incluidos con la instalación guiada de la GUI, pero a menos que esté haciendo algo muy mal, es básicamente inadecuado para documentar el código F# (incluso si funcionara realmente bien para C#). Tal vez funcione para otros, en cuyo caso estaría muy agradecido por un breve ejemplo completo del que podría comenzar. Muchas gracias.

Estoy consciente de Sandcastle no sale de todo, desde un ensamblaje F# , pero el proyecto a los que se hace referencia allí aún no parece listo para el horario estelar.

¿Seguramente debe haber algo que funcione de manera confiable y que sea "lo suficientemente bueno"? Muchas gracias por las sugerencias.

Editar: Muchas gracias a todos los que respondieron. La respuesta de Brian fue más cercana a lo que quería, así que la aceptaré. Sin embargo, el resultado es que no parece haber una solución adecuada para F# y que funcione de manera confiable. Me quedaré con los comentarios textuales por ahora.

Espero que fshtmldoc.exe comience a funcionar en algún momento. Si bien no puedo descartar que ya funciona y simplemente no lo usé correctamente, Google sugiere que no soy el único que descubre que aún no es perfecto.

Answer 1

No sé casi nada sobre Sandcastle, pero tenga en cuenta que, al igual que C#, en f#, puede usar comentarios de triple stebil, y se emitirán en el archivo de documentación XML que el compilador emite (en vs, en la página de propiedades del proyecto, la pestaña de compilación , verifique la casilla de verificación 'Archivo de documentación XML'; en la línea de comando, use la --doc argumentar fsc.exe.)

Ver también FsHtmlDoc.exe en el Paquete de energía.

Answer 2

También podrías mirar Focos

Produce una buena documentación basada en HTML. Ver aquí para un ejemplo:

Answer 3

También podrías ver Apistack de Intelifactorio. Me doy cuenta de que Focco requiere un enfoque muy diferente si ya tiene muchos comentarios estándar de DOC XML.

Answer 4

No lo he usado, pero puede valer la pena dar docu un intento...