是否有一个很好的快速入门指南，用于使用Sandcastle生成API文档？

Question

我将使用Sandcastle生成API文档 - 我找不到任何有关如何在该网站上执行此操作的指南。有没有人有他们推荐的快速入门指南？

Answer 1

我建议使用SHFB（如果可以的话），因为它使它变得更容易。 SHFB附带文档，但您可以在没有任何教程的情况下使用它的常用功能。

Answer 2

我也是SHFB的强烈支持，以至于在2010年9月我写了一篇关于Sandcastle和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。 Eric Brunsen的XML Documentation Comments Guide（Dynicity）
• Anson Horton的XML Documentation in C#（Microsoft C＃编译程序经理）

Answer 3

也许您可以查看SandCastle的（codeplex）网站。但我的经验是，最好只是玩它。首先要做的是配置应用程序以将注释生成为XML文件（并在代码中使用XML注释）。这是项目中的一个设置。

接下来你可以做的是将带有相关XML的程序集加载到Sandcastle中并使用设置（在大多数情况下，默认设置足够好）。大多数设置都是自我记录的，或者通过查看名称来显而易见。

祝你好运！