如何在Android Studio中显示用于Google Play Services API和Firebase API的API javadoc而不是没有文档的反编译类？

Question

当我点击我在Android Studio的Android项目中使用的任何Google Play Services API或Firebase API时,IDE会将我带到类的反编译版本,其中变量名称被混淆,并且没有任何文档的方法.有关如何直接在IDE中查看文档的任何想法？

我怀疑原因是播放服务和firebase服务不是开源的,我没有看到impls,我知道他们想保护它.但是,直接在IDE中查看文档而不是使用alt-tabbing到浏览器,我真的会受益.谢谢你的帮助.

Answer 1

Javadocs确实应该与客户端库一起分发.我们在谷歌内部有一个公开的问题,但我没有关于何时可以提供适当解决方案的时间表.但是,我可以为您提供一个可以应用于项目的解决方法.这不是一个很好的解决方案,但它是一个东西.

在我的OSX机器上,安装了Android SDK:

/Users/[myusername]/Library/Android/sdk

Play服务和Firebase javadocs的本地副本在这里(您的可能会有所不同):

/Users/[myusername]/Library/Android/sdk/extras/google/google_play_services/docs/reference/

您可以使用以下过程将此路径实际附加到Android Studio中的Firebase客户端库:

现在,当你为该库中的类召唤javadoc时,你会看到它.但是,您必须为每个需要javadoc的库执行此操作.

如果由于某种原因没有安装本地javadoc,则可以为javadoc附加远程URL.为此,使用带有小地球的加号按钮,并粘贴javadoc网址.对于Firebase,这是https://firebase.google.com/docs/reference/android和Play服务,这是https://developers.google.com/android/reference/

完成所有这些手动工作并不好,但至少它会在IDE中为您提供javadoc.

如果您想编写一个脚本来为您使用的所有内容附加此脚本,请知道此过程实际上只是修改.idea/libraries下的文件.您可以非常轻松地观察在IDE中进行更改时被修改的javadoc XML元素,如果需要,您可以自己编写脚本/编辑更改.

不幸的是,没有Play服务或Firebase这样的bug跟踪器(希望有!).如果您在https://firebase.google.com/support/contact/bugs-features/上将此错误记录下来,这实际上非常有用 - 这也应该在内部冒出来,您可以从以下角度进行跟踪:你自己的错误报告. (2认同)