我只是想知道 - Sandcastle 的最后一个版本是 2008 年 5 月发布的，并且它仍然被列为预发布软件/CTP，甚至不再获得许可，正如 EULA 特别指出的那样：
2.学期。 本协议的期限截至 2007 年 9 月 1 日或软件商业发布为止，以先到者为准。
由于 Sandcastle 无论如何都相当“重”，我只是想知道它是否仍然是正确的使用方式，或者是否有其他方法来创建 XmlDoc 文档？ （替代方案 = 我可以从我的构建中运行它以至少生成 HTML，最好也生成 PDF）。
I'm just wondering - the last release of Sandcastle is from May 2008, and it's still listed as Pre-Release Software/CTP and it's not even licensed anymore, as the EULA specifially says:
2.TERM. The term of this agreement is until September 1, 2007, or commercial release of the software, whichever is first.
As Sandcastle is rather "heavy" anyway, I just wonder if it is still the right thing to use, or if there are alternatives to create XmlDoc Documentation? (Alternatives = something I can run from my build to generate at least HTML, preferably PDF as well).
发布评论
评论（7）
没有人提到 Docu，这是由 FluentNHibernate 开发负责人 James Gregory 最近发起的一个项目。
这是一个非常简单且易于使用的工具，可以生成 html 文档 rdoc。 由于 Docu 使用 Spark 作为视图引擎，因此您可以轻松修改模板。
这是使用 Docu 构建的 FluentNHibernate 文档。
Nobody mentioned Docu, a recent project initiated by James Gregory, dev lead on FluentNHibernate.
It's a very simple and easy to use tool that generates html documentation a la rdoc. You can easily modify templates since Docu uses Spark as the view engine.
Here is the FluentNHibernate documentation built with Docu.
Microsoft Sandcastle 绝对仍然是正确的选择。 主要的替代方案（提供任何接近 Sandcastle 功能集的功能）是 NDoc，但最后一个版本那是更古老的事情了，是 2005 年 1 月！
尽管它在技术上仍处于（后期）预发布阶段，但实际上它是一个相当稳定的工具。 少数错误已通过补丁修复，可在 CodePlex 上作为 Sandcastle Styles 项目的一部分获得。 还有一个出色的 GUI，即 Sandcastle Help File Builder。
不过我不确定Sandcastle未来的发展。 我相信微软很可能会在某个时候继续对其进行工作/扩展，尽管似乎没有任何关于何时的消息。 目前，它无疑是为 .NET 库或应用程序创建正确文档的唯一合适的工具。 当然，您通常可以对小型项目/帮助文件使用更多“轻量级”工具。 我注意到的主要替代方案都是商业性的，而且不如 Sandcastle。
在某些情况下，手动生成文档/使用自定义自动化可能是可行的，但仅适用于小型项目（不太可能扩展。）
Microsoft Sandcastle is definitely still the right way to go. The main alternative (that offers anything close to the feature set of Sandcastle) is NDoc, but the last release of that is much older, being in January 2005!
Although it is still technically in (late) pre-release stage, it is in fact quite a stable tool. The small number of bugs have been fixed by patches, available on CodePlex as part of the Sandcastle Styles project. There's also a superb GUI for it, namely Sandcastle Help File Builder.
I am not sure about the future development of Sandcastle however. I believe it is likely Microsoft will continue work/expansion on it at some point, though there doesn't seem to be any news of when. It is certainly the only decent tool for creating proper documentation for a .NET library or application, at the moment. Of course you can often get away using more "light-weight" tools for small projects/help files. The main alternatives that I've noticed are both commercial and inferior to Sandcastle.
Generating documentation by hand/using custom automation is probably feasible in certain cases, but only for small projects (that are not likely to expand.)
据我所知，Sandcastle 仍然是一个有效的选择。 我最近使用过很多次，没有任何问题。 您可以在 MSDN 上查看此页面，然后向下滚动到“文档”部分以获取其他不错的选择：
C# 编程工具
As far as I'm aware, Sandcastle is still a valid choice. I've used it many times in the recent past and have no issues. You can check out this page on MSDN and scroll down to the 'Documentation' section for other good choices:
C# Programming Tools
为了有效地使用 Sandcastle，您还需要使用 Sandcastle 样式和 Sandcastle 帮助文件生成器 (SHFB)，正如 Noldorin 之前指出的那样。 它们都在 2010 年中期发布了新版本，因此绝对是最新工具。
然而，即使 SHFB 提供了干净、简单的 GUI，为了生成整洁、专业的文档集，您可能需要或想要考虑很多问题。 我的文章（“驯服沙堡：记录代码的 .NET 程序员指南"）记录了我在各种潜在陷阱方面的经验，发布于 Simple-Talk.com（2010 年 9 月），可能会为您节省一些时间、精力和痛苦:-)。
另一个有用的资源： 2010 年 10 月，我在这篇文章之后添加了 单页挂图，总结了 SHFB 的 XML 文档注释词典。
To effectively use Sandcastle you need, as Noldorin pointed out earlier, to also use Sandcastle Styles and Sandcastle Help File Builder (SHFB). They all had a new release in mid-2010 so are definitely current tools.
Even with the clean and simple GUI provided by SHFB, however, there are quite a number of issues 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") documenting my experience with a variety of potential pitfalls, published on Simple-Talk.com in September 2010, may save you some time, effort, and agony :-).
Another helpful resource: In October 2010 I followed up the article with a one-page wall chart that summarizes the XML documentation comment lexicon for SHFB.
沙堡仍然是一个正确的选择。 我过去在很多项目中都使用过它。
不管怎样，看看这些：
Sandcastle is still a right choice. I used it for many projects in past.
Anyway take at look at these:
DocProject 值得一看。 它消除了使用沙堡的很多痛苦。
DocProject is worth taking a look at. It takes away a lot of the pain of working with sandcastle.
我在这个问题中列出了一些文档工具的简短列表：
任何人使用- ndoc-or-a-similar-tool
我认为SandCastle是目前最好的开源工具（用于记录.NET项目），但是有几种商业工具，它们可以提供更好的性能和更多的功能，所以如果你为其中之一制定预算，至少值得评估它能为您带来什么价值。
I put a short list of some documentation tools in this SO question:
anyone-using-ndoc-or-a-similar-tool
I think SandCastle is the best opensource tool currently (for documenting .NET projects), but there are several commercial tools, and they can propose better performance and more features, so if you have a budget for one of them, it worth at least evaluating what value it could bring to you.