我有一个包含许多 C# 项目的 vs2012 解决方案。我想为整个库使用 Sandcastle 生成一些文档。
我一直在查看 Sandcastle 文档,但不清楚如何为整个项目生成文档。
我怎样才能为整个解决方案实现这一目标?
我有一个包含许多 C# 项目的 vs2012 解决方案。我想为整个库使用 Sandcastle 生成一些文档。
我一直在查看 Sandcastle 文档,但不清楚如何为整个项目生成文档。
我怎样才能为整个解决方案实现这一目标?
我使用了Sandcastle Helpfile Builder(而不是直接使用 Sandcastle)。
在 SHFB 项目中,您可以在<DocumentationSources>
节中指定多个 DLL+XML。
正如 ChrisW 所指出的,您应该使用 Sandcastle Help File Builder (SHFB)。然而,即使使用 SHFB 提供的干净和简单的 GUI,您也可能需要或想要考虑很多问题,以便生成一个整洁、专业的文档集。我的文章(“驯服沙堡:编写代码的 .NET 程序员指南”)记录了我在 Simple-Talk.com 上发布的各种潜在陷阱的经验,可能会为您节省一些时间、精力和痛苦 :-)。
一旦你消化了这篇文章,也许你会更感兴趣,我把 SHFB 和 Sandcastle 的完整语法和使用指南放在这张单页挂图上,可在 Simple-Talk.com 上找到。这里是一瞥: