记录f＃代码的最佳方法是什么？

Question

我已经尝试过Sandcastle以及指导GUI安装中包含的补丁，但除非我做错了什么，否则它基本上不适合记录F＃代码（即使它对C＃非常有用）。也许它适用于其他人，在这种情况下，我会非常感谢我可以从一个简短的完整例子开始。非常感谢。

我知道Sandcastle doesn't output everything from a F# assembly，但那里引用的项目尚未准备好迎接黄金时段。

肯定有一些可靠的工作并且“足够好”的东西？非常感谢任何建议。

编辑：非常感谢所有回复的人。布赖恩的回答最接近我想要的，所以我会接受它。然而，结果是似乎没有一个既适合F＃又能可靠运行的解决方案。我现在会坚持使用文字评论。

我希望FsHtmlDoc.exe在某些时候开始工作。虽然我不能排除它已经有效但我只是没有正确使用它，谷歌搜索它表明我不是唯一一个发现它还不完美的人。

Answer 1

我对Sandcastle几乎一无所知，但请注意，就像C＃一样，在F＃中你可以使用三斜杠注释，它们将在编译器输出的XML文档文件中输出（在VS中，在项目属性页面上） ，构建选项卡，选中“Xml文档文件”复选框;在命令行中，使用--doc参数fsc.exe。）

另请参阅PowerPack中的FsHtmlDoc.exe。

Answer 2

您还可以查看Focco

它产生了一个很好的基于HTML的文档。有关示例，请参阅here：

Answer 3

您还可以从ApiStack查看IntelliFactory。我知道如果你已经有很多标准的XML文档评论，Focco需要一种非常不同的方法。

Answer 4

我还没有使用它，但值得docu尝试一下......