PhpStorm 2016.3 Help

Viewing PHPDoc Comments

Quick Documentation Lookup helps you get quick information for any symbol,
provided that this symbol has been supplied with Documentation comments in the applicable format.
PhpStorm recognizes inline documentation created in accordance with the PHP Documentation format.

To view documentation for a symbol at caret, do one of the following

Provided that the check box
Show quick doc on mouse move in the editor settings is
selected, just move your mouse pointer over the desired symbol.

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 Code Completion page of the
Settings/Preferences dialog.

Quick Documentation Lookup Window

Toolbar of the quick documentation lookup

The Quick Documentation Lookup 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.

When pinned, the Quick Documentation Lookup turns into Documentation Tool Window, with the
corresponding sidebar icon, and more controls.

Icon

Shortcut

Description

Left or Right

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

On an OS X computer, you
can also use the three-finger right-to-left and left-to-right swipe gestures.

Shift+F1

View external documentation in the default browser.

F4

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

Turn the Auto-update from source option on or off.
When the option is on, the information in the tool window is synchronized with your navigation
in the editor and other places in the UI.

Click this icon to show font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.