記錄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。

2011-11-30 23:34:34 Brian

非常感謝。不幸的是，我似乎碰到了http://fsharppowerpack.codeplex.com/workitem/6375#（儘管很容易，無論我和誰報告錯誤都會出錯） – user1002059

你也可以看看Focco

它產生了很好的基於HTML文檔。以here爲例：

2011-12-01 22:15:08 7sharp9

非常感謝。我可能還會使用它，但是我真的希望找到一些使用反射來記錄參數類型的東西。 – user1002059

您還可以從IntelliFactory檢出ApiStack。我知道Focco需要一種非常不同的方法，如果你已經有很多標準的XML文檔評論。

2011-12-01 23:47:31

非常感謝。不幸的是，我不允許發佈源代碼。 – user1002059

我還沒有使用它，但它可能值得給docu一個嘗試...

2011-12-04 18:44:18

回答