我将使用 Sandcastle 生成 API 文档 - 我在该网站上找不到任何有关如何执行此操作的指南。有没有人推荐任何快速入门指南？
问问题
396 次
3 回答
8
我建议使用SHFB（如果可以的话），因为它真的更容易。SHFB 附带文档，但您无需任何教程即可使用它的常用功能。
于 2009-08-04T18:38:50.653 回答
2
我也是SHFB的大力支持者，以至于在 2010 年 9 月，我写了一篇关于 Sandcastle 和 SHFB 的大型文章，题为Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code其中我描述了使用技巧和许多潜在的陷阱一个很可能会遇到。2010 年 10 月，我用一页挂图总结了 SHFB 的 XML 文档注释词典。
根据我对本文的研究，以下是其他有用资源的完整列表：
- Eric Woodruff 的Sandcastle 帮助文件生成器文档(SHFB Creator)
- C# 编程指南：文档注释的推荐标记(MSDN)
- 米。Eric Brunsen 的XML 文档评论指南（Dynicity）
- Anson Horton在 C# 中的 XML 文档（Microsoft C# 编译器程序管理器）
于 2010-10-23T16:27:24.827 回答
0
也许您可以查看SandCastle的（codeplex）站点。但我的经验是，最好只是玩弄它。您必须做的第一件事是配置您的应用程序以将您的注释生成到一个 XML 文件中（并在您的代码中使用 XML 注释）。这是您项目中的设置。
接下来您可以将带有关联 XML 的程序集加载到 Sandcastle 并使用设置（在大多数情况下，默认设置就足够了）。大多数设置都是自我记录的，或者通过查看名称显而易见。
祝你玩得开心！
于 2009-08-04T18:39:03.273 回答