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

问题描述：

我已经尝试了与指导GUI安装中包含的修补程序一起使用的Sandcastle，但除非我做的事情非常错误，否则它基本上不适合记录F＃代码（即使它能很好地用于C＃）。也许它适用于其他人，在这种情况下，我会非常感激我可以从一个简短的完整例子开始。非常感谢。记录f＃代码的最佳方式是什么？

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

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

编辑：非常感谢所有回复的人。 Brian的答案与我想要的最接近，所以我会接受它。然而，结果是似乎并没有适合F＃的解决方案，并且工作可靠。现在我会坚持文字评论。

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

答

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

而且，看到FsHtmlDoc.exe在PowerPack。

非常感谢。不幸的是，我似乎碰到了http://fsharppowerpack.codeplex.com/workitem/6375#（尽管很容易，无论我和谁报告错误都会出错） – user1002059

答

你也可以看看Focco

它产生了很好的基于HTML文档。以here为例：

非常感谢。我可能还会使用它，但是我真的希望找到一些使用反射来记录参数类型的东西。 – user1002059

答

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

非常感谢。不幸的是，我不允许发布源代码。 – user1002059

答

我还没有使用它，但它可能值得给docu一个尝试...