2011-11-30 45 views
8

Ho provato Sandcastle con le patch incluse con l'installazione GUI guidata, ma a meno che non stia facendo qualcosa di molto sbagliato è fondamentalmente inadatto per la documentazione del codice F # (anche se funzionerebbe davvero bene per C#). Forse funziona per gli altri, nel qual caso sarei molto grato per un breve esempio completo da cui potrei partire. Grazie molto.Qual è il modo migliore per documentare il codice f #?

Sono a conoscenza di Sandcastle doesn't output everything from a F# assembly, ma il progetto a cui fa riferimento non è ancora pronto per la stampa in prima serata.

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

Modifica: Molte grazie a tutti coloro che hanno risposto. La risposta di Brian è stata la più vicina a ciò che volevo, quindi lo accetterò. Tuttavia, il risultato è che non sembra esserci una soluzione che sia adatta a F # e che funzioni in modo affidabile. Continuerò con commenti testuali per ora.

Mi aspetto che FsHtmlDoc.exe inizi a funzionare ad un certo punto. Mentre non posso escludere che funzioni già e io non l'ho usato correttamente, googling suggerisce che non sono il solo a scoprire che non è ancora perfetto.

risposta

3

So quasi nulla di Sandcastle, ma nota che come C#, in F # è possibile utilizzare i commenti a tripla barra, e verranno emessi nel file di documentazione XML che il compilatore emette (in VS, sulle proprietà del progetto pagina scheda costruire, selezionare la casella 'Xml documentazione file', sulla riga di comando, utilizzare l'argomento --doc-fsc.exe)

Inoltre, vedere FsHtmlDoc.exe nel PowerPack..

+0

Molte grazie. Sfortunatamente, mi sembra di imbattersi in http://fsharppowerpack.codeplex.com/workitem/6375# (anche se potrebbe facilmente essere che sia io sia chiunque abbia segnalato che il bug ha fatto qualcosa di sbagliato) – user1002059

2

Si potrebbe anche guardare Focco

Produce una bella documentazione basato su HTML. Vedere here per un esempio:

+0

Molte grazie. Potrei ancora usarlo, tuttavia speravo davvero di trovare qualcosa che documentasse i tipi di argomento usando la riflessione. – user1002059

1

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

+0

Mille grazie. Sfortunatamente, non sono autorizzato a pubblicare il codice sorgente. – user1002059

0

non l'ho usato, ma forse vale la pena dare una prova docu ...

Problemi correlati