自動生成的混合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項目的文檔

回答

相關問題