有没有使用Sandcastle生成API文档的快速入门指南？

Question

我将使用Sandcastle生成API文档-我在那里的网站上找不到任何关于如何做到这一点的指南。有没有人有推荐的快速入门指南？

Answer 1

我建议使用SHFB (如果可以的话)，因为它真的很容易。SHFB附带文档，但您将能够使用它的常用功能，而无需任何教程。

Answer 2

我也是SHFB的坚定支持者，以至于在2010年9月我写了一篇关于沙堡和SHFB的相当大的文章，标题是Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code，其中我描述了使用技巧和可能遇到的许多潜在陷阱。在2010年10月，我发布了一个one-page wall chart，它总结了SHFB的XML文档注释词典。

根据我为这篇文章所做的研究，下面是其他有用资源的完整列表：

• Eric Woodruff的Sandcastle Help File Builder Documentation (SHFB创建者)
• C#编程指南：Recommended Tags for Documentation Comments (MSDN)
• Wm.埃里克·布伦森的XML Documentation Comments Guide (Dynicity)
• Anson Horton的XML Documentation in C# (微软C#编译器程序管理器)

Answer 3

也许你可以查看SandCastle的(codeplex)站点。但我的经验是，最好只是玩玩它。您必须做的第一件事是配置您的应用程序，以便将您的注释生成到一个XML文件中(并在代码中使用XML注释)。这是您项目中的一个设置。

你可以做的下一件事是将你的程序集与相关的XML加载到Sandcastle中，并使用这些设置(在大多数情况下，默认设置就足够好了)。大多数设置都是自文档化的，或者通过查看名称就很明显。

祝你玩它好运！