如何为 Android 兼容包安装 javadoc？答案

【问题标题】：How to install javadoc for Android Compatibility Package?如何为 Android 兼容包安装 javadoc？
【发布时间】：2011-12-20 14:45:28
【问题描述】：

如何为android 1.4 兼容包生成自定义javadoc？

参考文档可在线获取 (example)，但我是否可以在某些地方获取带有 javadoc 的 zip 文件，以供离线使用？

我想使用 javadoc 会很简单，只需设置兼容性 jar 的 javadoc 位置即可。

【问题讨论】：

【解决方案1】：

您可以根据源代码自行离线生成 javadoc。只需导航到您的 android sdk 目录，然后执行以下操作

cd <path_to_android_sdk>/extras/android/compatibility/v4/
mkdir docs

对于 Windows：

javadoc -d docs -sourcepath src\java -subpackages android.support.v4

对于 Linux/Mac：

javadoc -d docs -sourcepath src/java -subpackages android.support.v4

这将在您刚刚创建的 docs 目录中为您本地生成 javadocs。

然后在您的 eclipse android 项目中，转到您添加 android-support-v4.jar 的项目属性，编辑它的属性并将路径添加到您刚刚创建的 javadocs。

应该可以！

ADT 17+ 问题：

正如你们中的一些人指出的那样。让 Eclipse 查看附加的 ADT 17+ 的 javadoc 时出现问题。这是一个已知问题，并且已提交错误。这与生成 javadoc 的方式无关（如上所述），而是 ADT 17+ 与 Eclipse 集成的问题。有人描述了一种解决方法，可以在此处进行操作：

【讨论】：

它在 Mac 上的 'src/java'。 w00p w00p ty
注意： 自 ADT 17 以来，此解决方案不再有效。 Source
您仍然可以使用我上面写的内容生成 javadoc（这是问题的目的）。如果现在 Eclipse 和 ADT 存在问题，您可以在 IDE 中看到它，这是另一个需要解决的问题。不过感谢您指出！很高兴知道
注意： 以下是让 eclipse 查看 javadocs 的方法：stackoverflow.com/questions/9873152/…（对我来说，之后我还必须重新启动 eclipse，并保持文档不变开车）
如果 Eclipse 会直接从源文件中读取 Javadocs，为什么还要额外执行生成 Javadocs 的步骤？我刚刚用一行src=/opt/android-sdk/extras/android/support/v4/src 创建了文件libs/android-support-v4.jar.properties，javadocs 出现在Eclipse 中。

【解决方案2】：

问题：如果android-support-v4.jar 位于/libs 文件夹中（根据 ADT 17+ 的要求），则 javadoc 不可用。

编辑：我通过将离线版本的 android javadoc 链接到 android-support-v4.jar 解决了这个问题。据我所知，仍然无法链接在线版本（http://developer.android.com/reference）。步骤：

从 SDK 管理器下载 Android SDK 文档。您可以在最新的 Android 版本 (4.1) 下找到它
将 javadoc 文件夹链接到项目文件夹，在 Windows 中打开控制台并键入：MKLINK /J {PROJECT_PATH}\android_docs {SDK_PATH}\docs\reference
使用此内容创建文件libs/android-support-v4.jar.properties：
```
src=android-support-v4.jar
doc=../android_docs
```
关闭项目并重新打开它。必要时清洁。
javadoc 已链接。通过转到任何支持库类来检查它，例如 android.support.v4.app.FragmentActivity

【讨论】：

您仍然可以离线生成 javadoc 以在浏览器中或手动查看。您正在描述将其附加到 IDE 以简化编码体验的问题。
这是固定的/错误的：stackoverflow.com/questions/9873152/…（对我来说，之后我还必须重新启动 eclipse，并将文档保存在同一个驱动器上）

【解决方案3】：

@wnafee 的答案很准确，但如果您使用的是 Linux，请不要忘记在此位置使用正斜杠字符，例如 src/java。

【讨论】：

【解决方案4】：

如果您在 WINDOWS 上并且像我一样被卡住了很长时间，请确保您在属性文件中逃脱了反斜杠，否则事情将默默地失败。（无论如何，谁制造了静默失败的加载器......）

这是我的属性文件：

src=android-support-v4.jar
doc=doc\\android-support-v4_doc

我的目录是这样的：

android-support-v4.docs.zip
android-support-v4.jar
android-support-v4.jar.properties
doc

关闭项目并打开，这一切都对我有用。

【讨论】：

【解决方案5】：

【讨论】：

【解决方案6】：

我浏览了所有这些解决方案，但都没有奏效。以下是我为使其正常工作所做的工作：

导航到以下文件夹： D:\\Android-SDK\android-sdk-windows\extras\android\support\v4
运行命令： javadoc -d docs -sourcepath src\java -subpackages android.support.v4
在项目的 libs 目录中，创建一个名为 android-support-v4.jar.properties 的文件
在属性文件中，添加以下行（更改路径以匹配您的）：

doc=D:\Program Files\Android-SDK\android-sdk-windows\extras\android\support\v4\docs src=D:\Program Files\Android-SDK\android-sdk-windows\extras\android\support\v4\src
在 Eclipse 中，打开 Build 的属性对话框，然后导航到 Java Build Path 并选择 Libraries 选项卡。
扩展支持库。在我的情况下，路径是： D:\Program Files\Android-SDK\android-sdk-windows\extras\android\support\v4
选择 Javadoc 位置。单击编辑按钮，然后选择文档的路径。就我而言，它是： file:/D:/Program Files/Android-SDK/android-sdk-windows/extras/android/support/v4/docs/
关闭所有内容，包括 Eclipse 并重新启动。您现在应该可以浏览代码中的文档了。

【讨论】：