我只是想知道——Sandcastle 的最后一个版本是从 2008 年 5 月开始的，它仍然被列为预发布软件/CTP，甚至不再获得许可，正如 EULA 特别指出的那样：
2.期限。本协议有效期至 2007 年 9 月 1 日或软件的商业版本，以先到者为准。
由于 Sandcastle 无论如何都相当“沉重”，我只是想知道它是否仍然是正确的使用方法，或者是否有其他方法可以创建 XmlDoc 文档？（替代方案 = 我可以从我的构建中运行以生成至少 HTML，最好是 PDF）。
问问题
5786 次
7 回答
13
Microsoft Sandcastle 绝对是正确的选择。主要的替代方案（提供任何接近 Sandcastle 功能集的东西）是NDoc，但它的最后一个版本要旧得多，是在 2005 年 1 月！
尽管它在技术上仍处于（后期）预发布阶段，但它实际上是一个相当稳定的工具。少量错误已通过补丁修复，CodePlex 作为Sandcastle Styles项目的一部分提供。它还有一个极好的 GUI，即Sandcastle Help File Builder。
但是，我不确定 Sandcastle 的未来发展。我相信微软很可能会在某个时候继续对其进行工作/扩展，尽管似乎没有任何关于何时的消息。目前，它无疑是为 .NET 库或应用程序创建适当文档的唯一不错的工具。当然，对于小型项目/帮助文件，您通常可以使用更多“轻量级”工具。我注意到的主要替代品既商业化又不如 Sandcastle。
在某些情况下，手动生成文档/使用自定义自动化可能是可行的，但仅适用于小型项目（不太可能扩展）。
于 2009-06-12T14:00:21.743 回答
13
没有人提到 Docu，这是由 FluentNHibernate 的开发负责人 James Gregory 最近发起的一个项目。
这是一个非常简单易用的工具，可以生成 html 文档 a la rdoc。由于 Docu 使用Spark作为视图引擎，因此您可以轻松修改模板。
这是使用 Docu 构建的FluentNHibernate 文档。
于 2009-06-12T14:16:41.987 回答
3
据我所知，Sandcastle 仍然是一个有效的选择。我最近使用过很多次，没有任何问题。您可以在 MSDN 上查看此页面并向下滚动到“文档”部分以获取其他不错的选择：
于 2009-06-12T13:58:26.617 回答
3
正如 Noldorin 之前指出的那样，要有效地使用 Sandcastle，您还需要使用 Sandcastle Styles 和 Sandcastle Help File Builder (SHFB)。他们都在 2010 年年中发布了新版本，因此绝对是当前的工具。
然而，即使使用 SHFB 提供的简洁明了的 GUI，您也可能需要或想要考虑很多问题，以便生成整洁、专业的文档集。我于 2010 年 9 月在Simple-Talk.com上发表的文章（“驯服沙堡：编写代码的 .NET 程序员指南”）记录了我对各种潜在陷阱的体验，可能会为您节省一些时间、精力和痛苦： -)。
另一个有用的资源： 2010 年 10 月，我用一页挂图跟进了这篇文章，该挂图总结了 SHFB 的 XML 文档注释词典。
于 2010-09-14T22:53:56.397 回答
1
DocProject值得一看。它消除了使用沙堡的许多痛苦。
于 2009-06-12T14:24:08.940 回答
1
我在这个 SO 问题中列出了一些文档工具的简短列表： anyone-using-ndoc-or-a-similar-tool
我认为 SandCastle 是目前最好的开源工具（用于记录 .NET 项目），但是有几个商业工具，它们可以提出更好的性能和更多的功能，所以如果你有其中一个的预算，至少值得评估它能给你带来什么价值。
于 2009-07-29T14:23:46.913 回答