DocProject与Sandcastle帮助文件生成器GUI

Question

我有几个C＃项目以及一些我试图一起记录的内部库组件。 Sandcastle似乎是从C＃生成文档的地方。我想知道DocProject或Sandcastle帮助文件生成器GUI中的哪一个更好，并支持我需要的功能。

我想只编译每个项目自己的部分文档，然后将它们全部集成到一起。 （即一个文档项目中的库组件和它自己的文档项目中的每个项目，然后使用Help 2查看器在单个根目录中的所有上述内容）

Answer 1

我可以保证Sandcastle帮助文件生成器。它工作得很好，您可以在Sandcastle帮助文件生成器项目中记录任意数量的程序集。从理论上讲，您可以拥有一个Builder项目并为每个C＃项目生成一个doc，然后有一个master Builder项目来记录所有内容。

Answer 2

以下是基于Sandcastle的.NET文档的一些有用链接：

Tutorial on Sandcastle

Sandcastle Help File Builder（SHFB）
Tutorial on SHFB

Web Project Documentation
Tutorial on how to document Web Projects（更多手册，我相信之前的链接过时了）

MSDN reference for XML Documentation

Answer 3

我没有使用过DocProject，但它看起来像是一款具有与Sandcastle相当的功能的产品。

我使用了Sandcastle，我发现它是一种有效的工具。您还需要Sandcastle Help File Builder（SHFB）为您提供良好的前端，正如其他人在此处提到的那样。此外，您需要Sandcastle Styles用于Sandcastle引擎的表示层补丁。虽然所有这三个组件都在2010年中期发布了新版本，但由于Firefox 3.6中的渲染缺陷（在此defect report的2010.09.06条目中记录），我推迟了从2008版本的升级。

我已经详细记录了我对平台描述该问题的经验以及您可能需要或想要考虑的各种其他内容，以便生成整洁，专业的文档集。我的文章“Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code”刚刚于2010年9月在Simple-Talk.com发布;它可以节省你一些时间，精力和痛苦： - ）。

Answer 4

Doc Project生成更精美的文档 - 当它工作时 - 这不是所有的时间。这是一个更加生动的产品。

Sandcastle帮助文件构建器非常可靠，可以完成工作。