Sandcastle - 仍然是正确的用法?还是有其他选择吗?

时间:2009-06-12 13:50:47

标签: .net sandcastle

我只是想知道 - Sandcastle的最后一个版本是从2008年5月开始的,它仍然被列为预发布软件/ CTP,它甚至不再获得许可,因为EULA特别说:

  

2.TERM。本协议的有效期至2007年9月1日,或软件的商业发布,以先到者为准。

由于Sandcastle相当“重”,我只是想知道它是否仍然是正确的选择,或者是否有其他方法可以创建XmlDoc文档? (替代品=我可以从我的构建中运行以生成至少HTML,最好是PDF)。

7 个答案:

答案 0 :(得分:13)

微软Sandcastle绝对是正确的选择。主要的替代方案(提供接近Sandcastle功能集的任何东西)是NDoc,但最后一个版本更老,是在2005年1月!

虽然它在技术上仍处于(后期)预发布阶段,但它实际上是一个非常稳定的工具。修补程序修复了少量错误,作为Sandcastle Styles项目的一部分,CodePlex上提供了修补程序。它还有一个极好的GUI,即Sandcastle Help File Builder

然而,我不确定Sandcastle的未来发展。我相信微软可能会在某个时候继续开展工作/扩展,尽管似乎没有任何关于何时的消息。它当然是为.NET库或应用程序创建适当文档的唯一合适的工具。当然,对于小型项目/帮助文件,您通常可以使用更多“轻量级”工具。我注意到的主要替代方案既有商业用途,也不如Sandcastle。

在某些情况下,手动/使用自定义自动化生成文档可能是可行的,但仅适用于小型项目(不太可能扩展)。

答案 1 :(得分:13)

没有人提到过最近由James Gregory发起的项目Docu,他是FluentNHibernate的负责人。

这是一个非常简单易用的工具,可以生成html文档la rdoc。您可以轻松修改模板,因为Docu使用Spark作为视图引擎。

以下是使用Docu构建的FluentNHibernate documentation

答案 2 :(得分:3)

据我所知,Sandcastle仍然是一个有效的选择。我最近已经多次使用它并没有问题。您可以在MSDN上查看此页面,然后向下滚动到“文档”部分以获取其他不错的选择:

C# Programming Tools

答案 3 :(得分:3)

为了有效地使用Sandcastle,正如Noldorin先前指出的那样,你需要使用Sandcastle样式和Sandcastle帮助文件生成器(SHFB)。他们都在2010年中期发布了新版本,因此绝对是当前的工具。

即使使用SHFB提供的简洁图形用户界面,但是为了生成整洁,专业的文档集,您可能需要或想要考虑很多问题。我的文章(“Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code”)记录了我在2010年9月Simple-Talk.com发布的各种潜在陷阱的经验,可以节省一些时间,精力和痛苦: - 。)

另一个有用的资源:2010年10月,我使用one-page wall chart跟进了文章,该文章总结了SHFB的XML文档评论词典。

答案 4 :(得分:1)

Sandcastle仍然是一个正确的选择。我过去曾在很多项目中使用它。

无论如何看看这些:

答案 5 :(得分:1)

DocProject值得一看。它消除了与沙堡一起工作的痛苦。

答案 6 :(得分:1)

我在这个SO问题中列出了一些文档工具的简短列表: anyone-using-ndoc-or-a-similar-tool

我认为SandCastle是目前最好的开源工具(用于记录.NET项目),但有几种商业工具,他们可以提出更好的性能和更多的功能,所以如果你有其中一个的预算,值得至少评估它可以为你带来什么价值。