2009-07-03 67 views
2

我有一组相关组件,它们基本上为各种“客户端”环境(如CLR和Java)提供相同的功能。目前,我正在使用Sandcastle为CLR组件生成我的文档,并且我即将开始使用Java。我想继续生成一个统一的文档,并且在所有组件(CLR/Java以及后续的任何组件)中具有一致的外观和感觉。该文档将只在网站上提供,所以我只关心html格式,不使用CHM或其他格式。Sandcastle针对C#和Java项目的统一文档生成

这可能吗?正如我所看到的,如果我可以将Java文档收集到Sandcastle所用模式的XML文件中,以便让Sandcastle为所有平台生成所有文档,那么这将是可能的。这个过程(不知何故)在这里描述:http://sandcastle.codeplex.com/Thread/View.aspx?ThreadId=32301

是否有一些更直接,更简单,替代?

回答

2

如果我正确地理解了这个问题,您希望.NET和Java文档具有统一的外观和感觉。您要使用的选项是使用Sandcastle Builder从您在Java中拥有的文档生成HTML文档。

我认为这可能是错误的方法,因为Sandcastle会蹒跚发现Java中存在的类型,即使它被输出为Sandcastle期望的XML格式。

我的方法是为您的Java文档编写doclet,以匹配.NET/Sandcastle/MSDN样式文档的样式。默认的Javadoc HTML风格是可怕的,默认的.NET MSDN风格文档在我看来非常优越,所以匹配这些将是最好的方法。

已经写入了丰富的doclets。我无法找到生成XML的链接(doclet.com网站上的链接不正确)。一个IBM工具通过here来完成,不管它使用的是我不确定的doclet。

一旦拥有了XML,就可以调整Sandcastle构建器用来生成相同外观HTML的XSL。

希望这可以帮助+我在正确的路线。

更新

看样子有人作出了doclet生成MSDN文档:ndoclet,这意味着你可以跳过XSL转换过程。

1

我为我的项目尝试过Sandcastle,但它是减速的方式。

现在我使用doc-o-matic,它也支持Java。

+3

或doxygen作为一个自由aletrnative - http://www.stack.nl/~dimitri/doxygen/ - 也支持Java和.NET – 2009-07-11 13:54:46