用Sandcastle生成API文檔是否有一個很好的快速入門指南？

Question

我將使用Sandcastle生成API文檔 - 我找不到任何關於如何在網站上執行此操作的指南。有沒有人有任何快速入門指南，他們會推薦？

Answer 1

我建議使用SHFB（如果可以的話），因爲它使它更容易。 SHFB附帶了文檔，但是您可以在不使用任何教程的情況下使用它的常用功能。

Answer 2

也許你可以檢查（codeplex）網站SandCastle。但我的經驗是，最好只是玩弄它。你必須做的第一件事就是配置你的應用程序來將你的註釋生成一個XML文件（並且在你的代碼中使用XML註釋）。這是您項目中的一個設置。

您可以做的下一件事是將您的程序集與關聯的XML加載到Sandcastle中並使用設置進行播放（大多數情況下默認設置足夠好）。大多數設置都是自我記錄的，或者通過查看名稱顯而易見。

祝你好運！

Answer 3

我也強烈支持SHFB，以至於2010年9月我寫了一篇關於Sandcastle和SHFB的大規模文章，標題爲Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code，其中我描述了使用技巧以及很多可能遇到的潛在缺陷。在2010年10月，我跟進了這個文章，其中總結了SHFB的XML文檔評論詞典one-page wall chart。

從我的研究的文章，這裏是其它有用資源的完整列表：

• 埃裏克·伍德拉夫的Sandcastle Help File Builder Documentation（SHFB造物主）
• C＃編程指南：Recommended Tags for Documentation Comments（MSDN）
• 了Wm。埃裏克Brunsen的XML Documentation Comments Guide（Dynicity）
• 安森霍頓的XML Documentation in C#（微軟C＃編譯器項目經理）