Qual è il modo migliore di documentare f # codice?

Question

Ho provato Sandcastle con le patch inclusi con l'installazione grafica guidata, ma a meno che non sto facendo qualcosa di molto sbagliato è fondamentalmente inadatta per la documentazione del codice F # (anche se avrebbe funzionato molto bene per C #). Forse funziona per gli altri, nel qual caso sarei molto grato per un breve esempio completo che ho potuto iniziare da. Molte grazie.

Sono a conoscenza di Sandcastle non emette tutto da un F # di montaggio , ma il progetto di riferimento non ci sembra ancora pronto per il debutto.

Ci deve essere sicuramente qualcosa che funziona in modo affidabile ed è "abbastanza buono"? Molte grazie per qualsiasi suggerimento.

Edit: Molte grazie a tutti coloro che hanno risposto. La risposta di Brian era più vicino a quello che volevo, quindi mi accetto. Tuttavia, il risultato è che non sembra essere una soluzione che sia adatta a F # e che funziona in modo affidabile. Continuerò con commenti testuali per ora.

Mi aspetto FsHtmlDoc.exe inizierà a lavorare ad un certo punto. Mentre non posso escludere che funziona già e io non l'ho usato in modo corretto, googling suggerisce io non sono l'unico a scoprire che non è ancora perfetto.

Answer 1

so quasi niente di Castello di sabbia, ma è da notare che, come C #, in F # è possibile utilizzare i commenti triple-slash, e sarà emesso nel file di documentazione XML che le uscite del compilatore (in VS, nella pagina delle proprietà del progetto , scheda di compilazione, controllare la casella di controllo 'file di documentazione XML.'; sulla riga di comando, utilizzare l'argomento --doc a fsc.exe)

Inoltre, vedere FsHtmlDoc.exe nel PowerPack .

Answer 2

Si potrebbe anche guardare Focco

Si produce una documentazione basata bel html. Vedere qui per un esempio:

Answer 3

Si potrebbe anche verificare ApiStack da IntelliFactory . Mi rendo conto Focco richiede un approccio molto diverso se si ha già un sacco di commenti di documentazione XML standard.

Answer 4

Non ho usato, ma forse vale la pena dare docu una prova ...