有没有一个很好的快速入门指南生成与sandcastle的api文档?

我建议使用 SHFB (如果可以的话),因为这样做真的很容易。SHFB附带文档,但是您可以在没有任何教程的情况下使用它的公共特性。

我也非常支持 SHFB 如此之多以至于在2010年9月我写了一篇关于Sandcastle和SHFB的相当大的文章,题为 Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code 在这里,我描述了使用技巧以及人们可能遇到的许多潜在陷阱。在2010年10月,我用 one-page wall chart 它总结了SHFB的XML文档注释词典。

从我对这篇文章的研究来看,这里有一个其他有用资源的完整列表:

• 埃里克·伍德拉夫 Sandcastle Help File Builder Documentation (SHFB Creator)
• C编程指南: Recommended Tags for Documentation Comments (MSDN)
• WM。埃里克·布伦森 XML Documentation Comments Guide (Dyapunov)
• 安森·霍顿 XML Documentation in C# (Microsoft C编译器程序管理器)

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

接下来,您可以将带有关联XML的程序集加载到sandcastle中并使用这些设置(在大多数情况下,默认设置已经足够好了)。大多数设置都是自记录的,或者通过查看名称很明显。

祝你玩得好运!