问题标签 [javadoc]

我只是将一些生成的 javadoc 粘贴到一个 eclipse 项目中，发现没有一个 HTML 是兼容的。

甚至有关闭标签从未打开的情况。

有没有办法解决这个问题？也许是“合规”的选择......

我的 SVN 存储库中有一个第三方库，我想在 Eclipse 中将 source/javadoc 与它本地关联。即，应该有一些本地设置（例如，local.properties文件中的条目）将源/javadoc 与 JAR 文件相关联，但不会通过.classpath. 理想情况下我会有

在local.properties然后

在.classpath. 这可以做到吗？

[编辑] @VonC 的回答很有帮助......有没有办法从文本文件（例如，local.properties）加载路径变量，而不是通过 Window -> Preferences -> General -> Workspace -> Linked Resources？

我正在使用 Maven（和 Maven Eclipse 集成）来管理我在 Eclipse 中的 Java 项目的依赖关系。从 Maven 存储库自动下载 JAR 文件的功能可以节省实时时间。不幸的是，它不包括 API 文档和源代码。

如何设置 Maven 以自动获取源和 javadoc 附件并使用 Eclipse 正确注册它们？

我正在做一个项目，我们有一些自定义 Taglet 类用于修改 Javadocs（例如链接到 SVN 中的源代码，添加引用）等等。我们想做的一件事是能够获取源中使用的注释并从中操作信息。

Taglet 接口似乎没有提供一种简单的方法来访问 Java 源代码中的注释。有人知道这是否可能吗？

我正在使用 JDK 1.5

是否有人熟悉从类和 javadoc生成具有有意义名称的代码存根的工具？

真正的问题应该是“我有没有调试信息和匹配 javadoc 的类，但是我的 IntelliJ IDEA 8.0.1（请，没有 IDE 战争）没有考虑到 javadoc 并向我显示“void setLocation（Object object , String str1, int i1, int i2);" 而不是 "void setLocation(Object component, String name, int x, int y);" - 这对自动完成和易用性都有很大的不同”。如果能回答这个问题，我也很满意。

安瓿项目在 docstring 中使用了一些标签，例如 javadoc 的标签。

例如从pool.py第 86 行：

这些标签是什么，哪个工具使用它。

我通常对 JavaFX 不以为然，但至少他们的API 文档比 javadoc 有了很大的改进，javadoc 十年来没有任何实质性的改进。是否可以使用 JavaFX 技术为常规 Java 文件生成更具吸引力的 javadoc ？

我试图将 Ant 库添加到 Eclipse 中的项目中，并且我使用了属于 Eclipse 插件文件夹的那些库。当我尝试将它们与 Javadocs 相关联时，我无法在插件文件夹中找到它们。我在网上搜索了它们，发现了这个页面，他们说这些文档不是在线提供的，因为它们是每个发行版的一部分。那么我在哪里可以找到捆绑在 Eclipse 中的发行版中的文档？

在 C++ 中创建公共头文件时，您认为最佳实践是什么？

1. 头文件应该不包含、简短或大量的文档吗？我已经看到了从几乎没有文档（依赖于一些外部文档）到不变量、有效参数、返回值等的大型规范的所有内容。我不确定我到底喜欢什么，大型文档很好，因为你总是可以访问它来自您的编辑器，另一方面，带有非常简短文档的头文件通常可以在一两页文本上显示完整的界面，从而更好地概述类可以做什么。

2. 假设我使用简短或大量文档之类的东西。我想要类似于 javadoc 的东西，我在其中记录返回值、参数等。c++ 中最好的约定是什么？据我所知，doxygen 在 java doc 样式文档方面做得很好，但是在使用 javadoc 样式文档之前我应该​​了解其他任何约定和工具吗？

我想在 javadoc 中有自定义属性，例如“@owner”“@since-version”，我不想包含在 javadocs 中。有没有解决的办法？