Code reference information
In RubyMine, you can see where and how symbols, such as tags, classes, fields, methods, or functions are defined in your project. For this purpose, the IDE features the Quick Definition popup.
To view definition of a symbol, select it in the editor and press Ctrl+Shift+I (or click).
Alternatively, with the Ctrl key pressed, hover the cursor over any symbol. RubyMine displays the symbol as a link and shows its definition in a tooltip. Click this link to jump to the definition of the symbol.
Click the icon in the top-right corner to open the definition in the Find tool window. To open the source code of the definition for editing and close the popup, click the icon F4. To open the definition without closing the popup, click the Ctrl+Enter.
The Parameter Info popup shows the names of parameters in method and function calls. RubyMine automatically shows a popup with all available method signatures within 1 second (1000 milliseconds) after you type an opening bracket in the editor, or select a method from the suggestions list.
You can explicitly invoke the popup if it has closed or if your IDE is configured not to show the popup automatically. To do so, press Ctrl+P (or click ).
Show full method or function signatures
By default, the parameter info popup shows simple signatures. You can configure the IDE to show full signatures that include method names and returned types.
Configure the parameter info popup
In the Show the parameter info popup in ... milliseconds field, specify the time in milliseconds after which the popup should appear.
If you don't want the popup to appear automatically, clear the Show the parameter info popup in ... milliseconds checkbox.
Parameter hints are displayed in the editor inline with your code to increase its readability. They show the names of method parameters for passed values that are literals or nulls.
The hints are enabled by default. If you don't want to see them for specific methods, you can configure the list with exceptions.
Configure the parameter hints exception list
By default, the exception list contains a number of pre-defined methods. You can remove a method from the list to see the hints for it, or add new methods to hide their hints in the editor.
Select Parameter hints in the list in the middle section.
The options for configuring hints become available on the right.
Add methods for which you don't want to see the hints to the Blacklist section.
Apply the changes and close the dialog.
You can get quick information for any symbol or method signature by means of the Quick Documentation popup. Note that the symbol must be supplied with documentation comments created in accordance with YARD or RDoc markup, or with documentation from an SDK.
To view documentation for a symbol at caret, press Ctrl+Q (or click).
You can press Ctrl+Q again to switch between the popup and the toolbar.
Click the icon to change the font size, display the quick documentation toolbar, or go to the source code.
Automatically show quick documentation
In RubyMine, you can identify the type of an expression in the following way:
Place the caret at the necessary code element and press Ctrl+Shift+P (or selectfrom the main menu).
External documentation opens the necessary information in a web browser, so that you can navigate to related symbols, and keep the information for further reference at the same time.
View external documentation
To view documentation for a symbol at the current caret position in a web browser, press Shift+F1 (or click).
- Copy tooltip text to the clipboard
To copy tooltip text to the clipboard, hold Alt (on Linux, hold Ctrl+Alt) and click the tooltip.
- View context information
If the current method or class declaration is not visible, you can view it in the tooltip by pressing Alt+Q.