问题标签 [scaladoc]

我刚刚安装了全新安装的 Eclipse Indigo 的 Scala IDE Eclipse 插件。我在全新安装的 Indigo 上关注了 scala-ide.org 主页上的入门 youtube 视频。它没有显示 String Java 类的完整文档，而是显示“type String = String”

通过查看项目属性，我确实注意到，在项目中的 scala-library.jar 和其他项目中，在“javadoc 位置”下，它们显示“（无）-不可修改”。我不确定这是否是问题所在，或者 Scala 编辑器是否在其他地方获取了它的文档。

有没有其他人经历过这个和/或想出如何解决它？谢谢！

在创建 Scala 文档时，我还使用此处记录的@throws和@note标记(Scaladoc Wiki - Tags and Annotations)。

不幸的是，我在生成的Scaladoc中找不到这些。

是否必须设置某些开关，考虑特定的事情还是这是一个已知问题？

顺便说一句：使用 Scala 2.9.0.1 的scaladoc Ant 任务也不会发出警告。

编辑：顺便说一句，澄清一下：我不是指@throws注释

这在注释部分中有记录，def但@throwsScaladoc 的标签如

我喜欢一些关于如何最好地为混合 Java/Scala 项目自动生成文档的建议。我们使用的是 Scala 2.8；似乎 2.8.1 附带的 scaladoc 工具没有为我们的 Java 类生成可用的文档——它获得了正确的结构，但不包括文档。而 javadoc 显然只涵盖了 Java 部分。

我们研究了 Doxygen，但它不适用于开箱即用的 Scala，所以这是一个研究项目。

如果没有 100% 的 Java 或 100% 的 Scala，我们怎么能做到这一点？

谢谢！

我对如何在 Play 上运行 scaladoc 感到有点困惑！框架项目。似乎有很多错综复杂的问题需要解释，而我没有成功。

有我缺少的教程吗？您是否需要添加 sbt 或构建工具以使其合理？

我将 sbt 0.11.2 用于混合 Java/Scala 项目。我已经意识到，当我doc从 sbt 中运行命令时，它不仅为 Scala 源文件创建 scaladocs ，src/main/scala还为 Java 源文件src/main/java创建src/main/scala）。

但是，这看起来不太好。例如，对于Foo使用静态方法命名的 Java 类，在生成的 scaladoc 中有两个条目：一个Foo类和一个Foo对象。类只列出构造函数，对象列出静态方法。

有什么办法可以告诉 sbtsrc/main/java从 scaladoc 生成中排除该文件夹？我想为那些创建 javadocs。

是否可以在为 2.8.1 编写的 Scala 代码上使用来自主干的 scaladoc 而不会出现任何问题？我问是因为主干中的 scaladoc 支持一些在 2.8.1 的 scaladoc 中未实现的附加标签。

我预计不会有任何问题，但我只是想检查一下。

如果是这样，如何从 sbt 做到这一点？

有时在 ScalaDoc/JavaDoc 页面中查看光标下元素的类型会很方便。令人惊讶的是，我找不到任何 IDE 内置的方法来执行此操作（尽管事实上我使用的大多数库都附有文档和源 jar）。它在那里吗？

在Eclipse中，我将 Scala 项目的Javadoc Location属性设置为我的 Scala 项目的file:/D:/EclipseWorkspace/MyProject/target/scala-2.9.1/api位置D:/EclipseWorkspace/MyProject。

现在，如果我在一个实现类/特征的 Scala 文件中，当我键入Shift+时F2，Eclipse 会打开该类/特征的 Scaladoc 页面。但是，如果它是一个对象，这将不起作用，因为 Eclipse 尝试打开<ObjectName>.html而 Scaladoc 生成的文件名为<ObjectName>$.html.

有什么解决方法吗？

我有一个 Color 伴侣对象，其中包含一些有用的颜色，我想以下列方式记录它们：

您可能已经注意到，我想要的只是让字符串(.3, .3, .3, 1)显示val darkGrey在Color. 问题是 Scaladoc 将第一个句点之前的所有内容都视为一个句子，而之前的所有内容都隐藏在可扩展箭头的“内部”。所以我得到的是这样的：

这显然是不可取的。理想情况下，要么显示整个字符串，要么隐藏整个字符串。有没有办法实现其中任何一个？

我也尝试了以下两种方法，但都没有奏效。

目前，scaladoc 尝试在同一框架中打开所有链接 - 如果源位置无法在框架中工作（例如，github 页面），则会导致错误。

例如：扇贝

尝试通过左键单击链接来打开源代码会导致 Chrome 中没有任何内容，并且 Opera 中会出现错误。

有没有办法解决这种行为？