自动生成的混合java/scala项目的文档

我很想谈谈如何最好地为混合Java/Scala项目自动生成文档。我们正在使用Scala 2.8;似乎与2.8.1一起提供的scaladoc工具不会为我们的Java类生成可用的文档 - 它的结构正确，但不包括文档。而且javadoc显然只涵盖了Java部分。自动生成的混合java/scala项目的文档

我们看着Doxygen，但它不能与Scala一起使用，所以这是一个研究项目。

我们怎样才能做到这一点100％的Java或100％的斯卡拉？

谢谢！

来源

2011-12-02 Eric Bowman - abstracto -

我在项目中遇到同样的问题。目前我的解决方案看起来像我已经在Scala中编写了所有重要的**类（即需要文档的类）。另外，我为Scaladoc使用了一个'* .scala'过滤器，所以我放弃了Java类（在文档中）。有一段时间我有想法（未实现）来混合由Javadoc和Scaladoc生成的文档。但即使在调整CSS的时候，你也会混合使用两种不同的文档样式。 – binuWADa

您的项目是否将Scala和Java真的混合在相同的包中，或者分裂成不同的包？在后一种情况下，生成两个文档并交叉引用它们可能会起作用。 –

@PaŭloEbermann：事实上，大多数软件包都是用一种语言编写的。但我也有混合的情况。这主要来自以前的Java包。然后逐渐将其迁移到Scala，同时调整功能。然后，有时在一个包含Scala代码的包中保留独立的Java类。但如上所述，我只是将这些文件留在文档中。 – binuWADa

Play Framework为其Scala类生成scaladoc，为其Java类生成javadoc。请参阅generateAPIDocsTask： https://github.com/playframework/Play20/blob/master/framework/project/Build.scala

来源

2012-02-10 06:34:24

这并没有真正回答这个问题。 OP使用的是1.2.x版本，该链接适用于2.0版本，它具有完全不同的构建系统。 –

自动生成的混合java/scala项目的文档

回答

相关问题