What is the best way to document f # code?

Question

I tried Sandcastle with the patches included in the GUI managed installation, but if I am not doing something very wrong, this is basically not suitable for documenting F # code (even if it works very well for C #). Perhaps this works for others, in which case I would be very grateful for a short complete example from which I could start. Many thanks.

I know Sandcastle does not get everything out of the F # build , but the project to which it refers is not yet ready for prime time.

There must be something that works reliably and is "good enough"? Thanks so much for any suggestions.

Edit: Many thanks to everyone who answered. Brian's answer was closest to what I wanted, so I agree with that. However, the result is that there seems to be no solution that is suitable for F # and works reliably. For now, I will stick with text comments.

I expect FsHtmlDoc.exe to start working at some point. Although I cannot rule out that it works already, and I just did not use it correctly, googling suggests that I am not the only one who found it not yet ideal.

Answer 1

I don't know anything about Sandcastle, but note that, like C #, in F # you can use triple slash comments and they will be output in the XML documentation file that the compiler outputs (in VS, on the project properties page, insert tab, check the box "Xml documentation file", at the command line, use the --doc argument to fsc.exe .)

Also see FsHtmlDoc.exe in PowerPack .

Answer 2

You can also watch Focco

It creates good html-based documentation. See here for an example:

Answer 3

You can also check ApiStack from IntelliFactory . I understand that Focco requires a completely different approach if you already have a lot of standard comments on XML documents.

Answer 4

I have not used it, but it might be worth a try to try ...