生成c＃解决方案的sandcastle文档

Question

我有一个vs2012解决方案，它有很多C＃项目。我想使用Sandcastle为整个库生成一些文档。

我一直在审查Sandcastle文档，而不清楚如何为整个项目生成文档。

我怎样才能在整个解决方案中实现这一目标？

Answer 1

我使用Sandcastle Helpfile Builder（而不是直接使用Sandcastle）。

在SHFB项目中，您可以在<DocumentationSources>部分指定多个DLL + XML。

Answer 2

正如ChrisW所说，您应该使用Sandcastle帮助文件生成器（SHFB）。但是，即使使用SHFB提供的简洁图形用户界面，但是为了生成整洁，专业的文档集，您可能需要或想要考虑很多问题。我的文章（“Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code”）记录了我在Simple-Talk.com上发布的各种潜在陷阱的经验，可以为您节省一些时间，精力和痛苦： - ）。

一旦你消化了这篇文章，也许还有更多兴趣，我就在这个one-page wallchart上为SHFB和Sandcastle提供了一个完整的语法和用法指南，可以在Simple-Talk.com上找到。这是一瞥：