2011-11-30 29 views
8

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

Conozco Sandcastle doesn't output everything from a F# assembly, pero el proyecto al que se hace referencia allí todavía no parece estar listo para el horario de máxima audiencia.

Sin duda debe haber algo que funciona de manera confiable y es "lo suficientemente bueno"? Muchas gracias por las sugerencias.

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

Supongo que FsHtmlDoc.exe comenzará a funcionar en algún momento. Si bien no puedo descartar que ya funcione y no lo utilicé correctamente, buscar en Google sugiere que no soy el único que descubre que aún no es perfecto.

Respuesta

3

No sé casi nada sobre Sandcastle, pero tenga en cuenta que al igual que C#, en F # puede usar comentarios de triple barra, y se mostrarán en el archivo de documentación XML que el compilador genera (en VS, en las propiedades del proyecto página, pestaña construir, marca la casilla 'XML documentación de archivo'; en la línea de comandos, utilice el argumento --doc-fsc.exe)

también, ver FsHtmlDoc.exe en el PowerPack..

+0

Muchas gracias. Desafortunadamente, parece que me he encontrado con http://fsharppowerpack.codeplex.com/workitem/6375# (aunque podría ser muy fácil que tanto yo como el que informamos el error hiciéramos algo mal) – user1002059

2

También podría mirar a Focco

Produce una buena documentación en html. Ver here para un ejemplo:

+0

Muchas gracias. Todavía podría usarlo, sin embargo, realmente esperaba encontrar algo que documente los tipos de argumentos mediante el uso de la reflexión. – user1002059

1

También puede consultar ApiStack desde IntelliFactory. Me doy cuenta de que Focco requiere un enfoque muy diferente si ya tiene muchos comentarios de documentos XML estándar.

+0

Muchas gracias. Lamentablemente, no tengo permiso para publicar el código fuente. – user1002059

0

no he usado, pero podría valer la pena dar una oportunidad ... docu

Cuestiones relacionadas