AppCode 2018.3 Help

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 Documentation

AppCode 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.
ac QuickDoc3
Refer to the sections below for general procedures of the Quick Documentation presentation.

Documentation comments

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.

ac QuickDoc2
Refer to the sections below for general procedures of the Quick Documentation presentation.

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 Show documentation popup in field on the Code Completion page of the Settings/Preferences dialog.

View documentation for a symbol at caret

  • Choose View | Quick Documentation Lookup on the main menu.

  • Press F1.

  • 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.

Change the font size of quick documentation

  • Click Quick Documentation Settings 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 need to enable it in the General page of the editor settings.

    ctrl mouse wheel

    Refer to the section Zooming in the Editor for details.

Documentation window

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 F1.




icons actions back svg icons actions forward svg


Switch to the previous or next documentation page (e.g. after using hyperlinks).

icons actions edit svg


Switch to the item (e.g. source) that corresponds to the documentation page currently shown.


Click this icon to perform the following settings:
  • Show the font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.

  • Enable or disable auto-update of documentation from its source.

  • Control the window's position.

Last modified: 28 March 2019

See Also