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

Question

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

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

因为Sandcastle相当"重",我只是想知道它是否仍然是正确的使用,或者是否有替代方法来创建XmlDoc文档？(替代品=我可以从我的构建中运行以生成至少HTML,最好是PDF).

Answer 1

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

虽然它在技术上仍处于(后期)预发布阶段,但它实际上是一个非常稳定的工具.少量错误已通过补丁修复,可在CodePlex上作为Sandcastle Styles项目的一部分使用.它还有一个出色的GUI,即Sandcastle帮助文件生成器.

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

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

Answer 2

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

• 公告
• Docu网站

这是一个非常简单和易于使用的工具,可生成HTML文档一拉的RDoc.您可以轻松修改模板,因为Docu使用Spark作为视图引擎.

这是使用Docu构建的FluentNHibernate文档.