C# DocProject 与 Sandcastle 帮助文件生成器 GUI
声明：本页面是StackOverFlow热门问题的中英对照翻译，遵循CC BY-SA 4.0协议，如果您需要使用它，必须同样遵循CC BY-SA许可，注明原文地址和作者信息，同时你必须将它归于原作者（不是我）：StackOverFlow
原文地址: http://stackoverflow.com/questions/319632/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me):
StackOverFlow
DocProject vs Sandcastle Help File Builder GUI
提问by Nathan
I have several C# projects along with some internal library components that I'm trying to document together. Sandcastle seems to be the place to go to generate documentation from C#. I would like to know which of the two, DocProject or Sandcastle Help File Builder GUI is better and supports the features I need.
我有几个 C# 项目以及一些我试图一起记录的内部库组件。Sandcastle 似乎是从 C# 生成文档的地方。我想知道 DocProject 或 Sandcastle Help File Builder GUI 中哪一个更好，并支持我需要的功能。
I would like to compile only each projects own part of the document and then have it all integrated together in the end. (i.e. the library components in one documentation project and each project in it's own documentation project, then all of the above in a single root using the Help 2 viewer)
我想只编译每个项目自己的文档部分，然后最后将它们全部集成在一起。（即一个文档项目中的库组件和它自己的文档项目中的每个项目，然后使用 Help 2 查看器将上述所有内容都放在一个根目录中）
采纳答案by Ben Griswold
I can vouch for Sandcastle Help File Builder. It works really well and you can document any number of assemblies within a Sandcastle Help File Builder project. In theory, you could have a Builder project and generate a doc for each C# project and then have a master Builder project which documents everything.
我可以担保 Sandcastle 帮助文件生成器。它工作得非常好，您可以在 Sandcastle 帮助文件生成器项目中记录任意数量的程序集。理论上，您可以拥有一个 Builder 项目并为每个 C# 项目生成一个文档，然后拥有一个记录所有内容的主 Builder 项目。
回答by Gavin Miller
Here are some useful links for Sandcastle based .NET documentation:
以下是基于 Sandcastle 的 .NET 文档的一些有用链接：
Sandcastle Help File Builder(SHFB)
Tutorial on SHFB
关于 SHFB 的Sandcastle 帮助文件生成器(SHFB)
教程
Web Project Documentation
Tutorial on how to document Web Projects(More manual and I believe outdated given previous the link)
关于如何记录 Web 项目的Web 项目文档教程（更多手册，我认为之前的链接已经过时）
回答by Tekdream
Doc Project produces more polished docs - when it works - which isn't all the time. It's a much more flakey product.
Doc Project 会生成更多精美的文档 - 当它起作用时 - 这并非总是如此。这是一个更加古怪的产品。
Sandcastle Help File Builder is solid and gets the job done.
Sandcastle 帮助文件生成器是可靠的，可以完成工作。
回答by Michael Sorens
I have not used DocProject but it seems like a product with capabilities comparable to Sandcastle.
我没有使用过 DocProject，但它似乎是一款功能与 Sandcastle 相当的产品。
I have used Sandcastleand I find it an effective tool. You also need Sandcastle Help File Builder(SHFB) to give you a good front-end, as others have mentioned here. Furthermore, you need Sandcastle Stylesfor presentation-layer patches to the Sandcastle engine. While all three of these components had a new release in mid-2010, I am postponing upgrading from the 2008 release because of a rendering defect in Firefox 3.6 (documented in the 2010.09.06 entry of this defect report).
我使用过Sandcastle，我发现它是一个有效的工具。您还需要Sandcastle 帮助文件生成器(SHFB) 来为您提供良好的前端，正如其他人在此处提到的那样。此外，您需要Sandcastle Styles来为 Sandcastle 引擎提供展示层补丁。虽然所有这三个组件都在 2010 年年中发布了新版本，但由于 Firefox 3.6 中的渲染缺陷（记录在此缺陷报告的 2010.09.06 条目中），我将推迟从 2008 版本升级。
I have thoroughly documented my experience with the platform describing that issue and a variety of others that you may need or want to consider in order to produce a tidy, professional documentation set. My article "Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code" was just published on Simple-Talk.comin September 2010; it may save yousome time, effort, and agony :-).
我已经彻底记录了我在描述该问题的平台上的经验以及您可能需要或想要考虑的各种其他问题，以便生成一个整洁、专业的文档集。我的文章“驯服沙堡：.NET 程序员编写代码文档指南”刚刚于 2010 年 9 月在Simple-Talk.com上发表；它可能会为您节省一些时间、精力和痛苦:-)。
