8

我在 sbt 下有一个 Scala 项目。我想为它生成一个 javadoc,因为项目 API 的大多数用户都是 Java 开发人员。这可能吗?

4

2 回答 2

7

我假设您希望您的文档采用 JavaDoc 格式,以便让习惯于 java 库的人熟悉一些东西?

有一个来自 typesafe 的名为GenJavaDoc的项目,它可能就是您正在寻找的。它以与 javadoc 非常相似的格式为 scala 库生成文档。它可以集成到 sbt 构建中。

Akka 有一个非常完整的 java api,而且 Akka 的很多用户都来自 java 世界,所以显然他们有这个需求。

项目存储库

该工具生成的 Akka japi 文档

Roland Kuhn 的博客文章描述了该工具和基本原理

于 2013-06-30T07:43:31.340 回答
5
% sbt doc

您会在中找到结果target/scala-version/api(假设您使用的是没有多个子项目的简单 SBT 项目)。

更新:

实验表明 SBT 的命令为项目的 Scala 和 Java 源代码doc生成文档。

于 2013-06-29T23:31:48.853 回答