CODEWITHSUNDEEP
android-studioandroid-view
tyczj
tyczj

Reputation: 73753

How to view method information in Android Studio

In Eclipse, when you hover your mouse over a method, a window would appear with a description of what the method does, what the parameters mean and what it returns. Is there a way to get Android Studio to do the same thing?

Upvotes: 586

Views: 192333

Answers (16)

gjlmotea
gjlmotea

Reputation: 91

Here is the information I've organized from each answer. Thanks to everyone for their contributions.

Quick Documentation Lookup (Show documentation on hover)

Shortcut: Ctrl + Q (macOS: Command + J)

enter image description here

setting:

  • Disable support for screen readers

Appearance & Behavior > Appearance > Support screen readers

enter image description here

  • Tooltip delay time

Set a reasonable delay time

Editor > Code Editing > Tooltip delay

enter image description here

Documentation popup on the right side of usage

enter image description here

setting:

Editor > Code Completion > Show the documentation popup

enter image description here

Parameter info

Shortcut: Ctrl + P

enter image description here

Display basic code completion

Shortcut: Ctrl + Space (Windows might conflict with some language input methods, switch to full English)

enter image description here

Insert Live Template

Shortcut: Ctrl + J

enter image description here

enter image description here

refer to the official JetBrains standard shortcuts at: https://resources.jetbrains.com/storage/products/intellij-idea/docs/IntelliJIDEA_ReferenceCard.pdf

Upvotes: 0

A.G.
A.G.

Reputation: 2119

On Mac OS:

Preferences -> Editor -> Code Editing -> Quick Documentation -> Show quick documentation on hover

Upvotes: 1

Visual Sharp
Visual Sharp

Reputation: 3986

For Android Studio 4.1 and 4.2, this checkbox has moved under Editor → General → Code Completion.

Enter image description here

Upvotes: 6

uzay95
uzay95

Reputation: 16632

I'm using Visual Studio too much and I want to see parameters when I click on Ctrl + Space. That's why I'm using Visual Studio keys.

To change the keymap to the Visual Studio keymap:

Enter image description here

Enter image description here

Upvotes: 0

strikerdude10
strikerdude10

Reputation: 683

In addition to the answers here, you might want to make sure that the documentation is downloaded. To do that, go to SDK Manager:

Enter image description here

And then the SDK Tools tab and make sure Documentation for Android SDK is installed.

Enter image description here

If it isn't, check the box and click Apply.

Upvotes: 20

sivi
sivi

Reputation: 11114

MacBook: ⌘ + J or Fn + F1 does the same.

Also, use the one from the editor definition as explained above.

Upvotes: 2

Aspiring Dev
Aspiring Dev

Reputation: 555

Many of the other answers are all well, but if you want an informational tooltip instead of a full-blown window then do this: after enabling it using Ahmad's answer then click on the little pin on the upper right corner:

Enter image description here

After this the method information will appear on a tooltip like almost every other mainstream IDE.

Upvotes: 2

Varun Verma
Varun Verma

Reputation: 693

It comes very handy if you create a keymap for functionalities you use very frequently. By default (if you select an OS X v10.5 (Leopard) and later keymap):

  1. Ctrl + P: To see what parameters are expected by the function
  2. Command + J: To see the documentation
  3. Ctrl + Space: To see the autocomplete suggestions

Enter image description here

Upvotes: 32

Ahmad
Ahmad

Reputation: 72553

The easiest and the most straightforward way:

To activate: menu File → Settings → Editor → General

For Mac OS X, Android Studio → Preferences → Editor → General and check Show quick documentation on mouse move:

Settings dialog with checked option

Other ways:

  • You can go into your IntelliJ IDEA's bin folder and search for idea.properties. Add this line to the document:

    auto.show.quick.doc=true

Now you'll have the same floating documentation window like in Eclipse.

  • You have to press Ctrl + Q to see the Javadoc.

You can pin the window and make the documentation appear every time you select a method with your mouse though.

Android Studio 1.0: You have to hold Ctrl if you want to get hold of the documentation window, for example, scrolling documentation. Otherwise, as you move your mouse away from the method, the documentation window will disappear.

Upvotes: 959

Hải Phong
Hải Phong

Reputation: 5144

Yes, you can. Go to menu File → Settings → Editor → Show quick documentation on mouse move

Or, in Mac OS X, go to Android Studio → Preferences → Editor → General → Show quick doc on mouse move.

Upvotes: 125

Mukul Aggarwal
Mukul Aggarwal

Reputation: 1585

Go to Editor → Preference → Editor → General and choose Show quick doc on mouse hover!

Enter image description here

Upvotes: 7

Lazy Ninja
Lazy Ninja

Reputation: 22527

Android Studio 2.x.x
Moved under menu Editor → General

Enter image description here

Older Versions

Using Windows 7 and Android Studio 1.0.x it took me a while to figure out the steps provided in the answer.

To help further visitors save some time, here is the way I did it:

Go to menu File → Settings or press Ctrl + Alt + S.

The following window will open and check Show quick doc on mouse move under IDE Settings → Editor.

Show quick doc

Or just press Ctrl and hover your move over your method, class, etc.

Upvotes: 16

sirFunkenstine
sirFunkenstine

Reputation: 8495

On my Mac, CtrlF1 stopped working, but F1 on its own works.

Upvotes: 7

Richa
Richa

Reputation: 700

If you just need a shortcut, then it is Ctrl + Q on Linux (and Windows). Just hover the mouse on the method and press Ctrl + Q to see the doc.

Upvotes: 14

Md Imran Choudhury
Md Imran Choudhury

Reputation: 9997

If you need only Parameter info then:

On Mac, it's assigned to Command+P

On Windows, it's assigned to Ctrl+P

If you need document info then:

On Mac, it's assigned to Command+Q

On Windows, it's assigned to Ctrl+Q

Upvotes: 12

Vlad
Vlad

Reputation: 1018

On Mac the default key combination for showing the quick documentation is: CTRL + F1

The cursor has to be on the method when using this.

Upvotes: 7

Related Questions