混合(Scala / Java)项目的单一文档?

时间:2010-01-12 03:44:31

标签: java scala maven sbt

对于包含Scala和Java模块(并排)的项目,如何将scaladoc与javadoc结合使用,以提供项目文档的单一视图?

(这可能是使用maven,或ant,或sb​​t,更一般的问题)。

任何想法和经验都表示赞赏。

3 个答案:

答案 0 :(得分:5)

使用Scala 2.8的新scaladoc将取代Scala 2.7使用的scaladoc,差异将更加惊人。但是,有一个请求提供了一个函数,它将scaladoc转换为javadoc格式,供IDE在显示帮助时使用。

如果这个函数可用,那么从scaladocs生成javadocs的东西在理论上是可行的。

但是要使这一切成为现实,那些对这种事情感兴趣的人必须在适当的论坛上发言。而且,当然,如果他们的人数太小,除非他们为自己做,否则很可能没有任何事情发生。

答案 1 :(得分:2)

使用Scaladoc<>有什么好处?的Javadoc? Javadoc有很多工具,Scaladoc几乎都有。主流IDE(Eclipse,Netbeans,Idea - 现实世界的企业开发 - 而不是学术研究)对Scaladoc一无所知。好像在西伯利亚:孤立。

答案 2 :(得分:1)

Scaladocs和javadoc非常不同,格式不同。它们只是两种不同的动物,我认为将它们组合起来并不合理。因此,AFAIK,Maven不提供任何支持(这并不奇怪),只需单独生成它们。