Как лучше всего документировать код F#?

Question

Я попробовал Sandcastle с патчами, включенными в установку с управляемым графическим интерфейсом, но если я не делаю что -то очень неправильно, это в основном не подходит для документирования кода F# (даже если это будет очень хорошо для C#). Может быть, это работает для других, и в этом случае я был бы очень благодарен за короткий полной пример, с которого я мог бы начать. Большое спасибо.

Я знаю о Sandcastle не выводит все из сборки F# , но в прямом эфире проект еще не кажется готовым к прайм -тайм.

Конечно, должно быть что -то, что работает надежно и «достаточно хорошо»? Большое спасибо за любые предложения.

РЕДАКТИРОВАТЬ: Большое спасибо всем, кто ответил. Ответ Брайана был ближе всего к тому, что я хотел, поэтому я приму это. Тем не менее, результатом является то, что, по -видимому, нет решения, которое подходит для F#, и которое работает надежно. Я буду придерживаться текстовых комментариев сейчас.

Я ожидаю, что fshtmldoc.exe начнет работать в какой -то момент. Хотя я не могу исключить, что это уже работает, и я просто не использовал его правильно, гугливая, это говорит о том, что я не единственный, кто обнаружил, что это еще не идеально.

Answer 1

Я почти ничего не знаю о Sandcastle, но обратите внимание, что, как и C#, в F# вы можете использовать комментарии с тройным складом, и они будут выводиться в файле документации XML, который выводит компилятор (в VS, на странице свойств проекта, вкладка «Построить» , проверьте флажок «Файл документации XML»; в командной строке используйте --doc аргумент fsc.exe.)

Также см FsHtmlDoc.exe в Блок питания.

Answer 2

Вы также можете посмотреть Focco

Он создает хорошую документацию на основе HTML. Видеть здесь Для примера:

Answer 3

Вы также можете проверить Апистак из Интеллект. Анкет Я понимаю, что Focco требует совершенно другого подхода, если у вас уже есть много стандартных комментариев XML DOC.

Answer 4

Я не использовал это, но это может быть док Попробуй ...