自动生成的Java / scala混合项目文档 [英] Autogenerated documentation for a mixed java/scala project

问题描述

我想就如何最好地为混合Java / Scala项目自动生成文档提供一些建议。我们正在使用Scala 2.8；似乎2.8.1附带的scaladoc工具不会为我们的Java类生成可用的文档-它获得正确的结构，但不包含文档。而且Javadoc显然只涵盖Java部分。

I'd love some advice on how best to autogenerate documentation for a mixed Java/Scala project. We're using Scala 2.8; it seems the scaladoc tool that ships with 2.8.1 does not generate usable documentation for our Java classes -- it gets the structure right, but does not include the documentation. And javadoc obviously only covers the Java part.

我们研究了Doxygen，但它与Scala一起使用时无法使用，因此这是一个研究项目。

We looked at Doxygen, but it doesn't work with Scala out of the box, so that's a bit of a research project.

如果不使用100％Java或100％Scala，该怎么办？

How can we do this short of going 100% Java or 100% Scala?

谢谢！ / p>

Thanks!

推荐答案

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

Play Framework generates scaladoc for its Scala classes and javadoc for its Java classes. See generateAPIDocsTask: https://github.com/playframework/Play20/blob/master/framework/project/Build.scala

这篇关于自动生成的Java / scala混合项目文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！