Viewing Inline Documentation
Quick Documentation Lookup helps you get quick information for any symbol or just method signature information, provided that this symbol has been supplied with documentation comments in the applicable format.
Type inference support in Quick DocumentationAppCode handles the Quick Documentation for the inferred types of symbols for all the supported languages. The IDE infers the type of the expression based on the provided values and renders that information in the Quick Documentation Window.
Refer to the sections below for general procedures of the Quick Documentation presentation.
AppCode handles the Quick Documentation for a symbol from the line comments that start with the three slashes.
Documentation comments can be applied to the following symbols: class, structure, enum, protocol, interface, variable, property, parameter, method, etc. Refer to the sections below for general procedures of the Quick Documentation presentation.
To view documentation for the symbol at caret
Press N/A or chooseon the main menu.
Viewing quick documentation
Viewing documentation for a symbol at caret
When you explicitly invoke code completion, then quick documentation for an entry selected in the suggestion list can be displayed automatically. The behavior of quick documentation lookup is configured in the Autopopup documentation (ms) For explicitly invoked completion page of the Settings/Preferences dialog.
On the main menu, choose.
Provided that the checkbox Show quick doc on mouse move in the editor settings is selected, just move your mouse pointer over the desired symbol.
Changing font style of the quick documentation
Click in the upper-right corner of the quick documentation window, and move the slider.
- Rotate the mouse wheel while keeping the Ctrl key pressed.
Note that for this feature to work, you have to enable it in the General page of the editor settings.
Refer to the section Zooming in the Editor for details.
The Documentation pop-up window helps navigate to the related symbols via hyperlinks, and provides a toolbar for moving back and forth through the already navigated pages, changing font size, and viewing documentation in an external browser.
To switch between the Documentation pop-up window and the Documentation tool window, use N/A.