Каков наилучший способ документирования кода F #?

Question

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

Мне известно о Sandcastle не выводит все данные из сборки F # , но указанный там проект еще не готов к прайм-тайм.

Наверняка должно быть что-то, что работает надежно и "достаточно хорошо"?Большое спасибо за любые предложения.

Редактировать: Большое спасибо всем, кто ответил.Ответ Брайана был ближе всего к тому, что я хотел, поэтому я приму его.Тем не менее, результат заключается в том, что не существует решения, подходящего как для F #, так и надежного.Я буду придерживаться текстовых комментариев на данный момент.

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

Answer 1

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

Также см. FsHtmlDoc.exe в PowerPack .

Answer 2

Вы также можете взглянуть на Focco

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

Answer 3

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

Answer 4

Я не использовал его, но, возможно, стоило бы попробовать document ...