我有几个 C# 项目以及一些我试图一起记录的内部库组件。Sandcastle 似乎是从 C# 生成文档的地方。我想知道 DocProject 或 Sandcastle Help File Builder GUI 两者中的哪一个更好并且支持我需要的功能。
我想只编译每个项目自己的文档部分，然后最后将它们全部集成在一起。（即一个文档项目中的库组件和它自己的文档项目中的每个项目，然后使用 Help 2 查看器将上述所有内容放在一个根目录中）
Nathan
问问题
11775 次
4 回答
19
我可以担保 Sandcastle Help File Builder。它工作得非常好，您可以在 Sandcastle Help File Builder 项目中记录任意数量的程序集。理论上，您可以拥有一个 Builder 项目并为每个 C# 项目生成一个文档，然后拥有一个主 Builder 项目来记录所有内容。
于 2008-12-03T01:42:11.080 回答
8
以下是基于 Sandcastle 的 .NET 文档的一些有用链接：
关于 SHFB 的Sandcastle 帮助文件生成器(SHFB)
教程
关于如何记录 Web 项目的Web 项目文档教程（更多手册，我相信之前的链接已经过时）
于 2008-12-29T16:35:27.137 回答
3
我没有使用过 DocProject，但它似乎是一款功能可与 Sandcastle 相媲美的产品。
我使用过Sandcastle，我发现它是一个有效的工具。您还需要Sandcastle Help File Builder (SHFB) 来为您提供良好的前端，正如其他人在这里提到的那样。此外，您需要Sandcastle Styles来为 Sandcastle 引擎提供表示层补丁。虽然所有这三个组件都在 2010 年中期发布了新版本，但由于 Firefox 3.6 中的呈现缺陷（记录在此缺陷报告的 2010.09.06 条目中），我推迟了从 2008 版本的升级。
我已经彻底记录了我在描述该问题的平台上的经验，以及您可能需要或想要考虑的各种其他问题，以便生成一个整洁、专业的文档集。我的文章《驯服沙堡：编写代码的 .NET 程序员指南》刚刚于 2010 年 9 月在Simple-Talk.com上发表；它可能会为您节省一些时间、精力和痛苦:-)。
于 2010-09-14T23:06:03.147 回答
1
Doc Project 生成更精美的文档 - 当它工作时 - 并非一直如此。这是一个更加脆弱的产品。
Sandcastle 帮助文件生成器很可靠，可以完成工作。
于 2009-05-19T15:01:20.287 回答