Quick Documentation

With ReSharper, you can quickly review the documentation on a symbol right in the editor.

• When you hover the mouse over a symbol usage in the editor, you will see a popup with its brief description. For library symbols, you can Alt +click (Ctrl+Alt +click if you are on Linux) in the popup to copy its contents to the clipboard.

• The second way, which is described below, provides you with more details as well as the ability to study the documentation of related symbols.

tip

If you are studying a function call, you can invoke parameter information Ctrl+Shift+Space to view the list of overloads of the function.

When you type a method call you can check the documentation of the method as soon as you have typed the method name. If the method has multiple overloads, ReSharper will let you choose one of them:

Additional capabilities of the Quick Documentation popup include:

• Pin window button that comes in handy whenever you need to preserve the contents of the Quick Documentation popup before switching back to the editor. After you click this button, the popup will stay on top of the editor while you work with other Visual Studio user interface items.

• Browser-like back/forward navigation buttons in the top left corner of the popup.

• Hyperlinks that let you navigate to documentation for related entities, including:

  • The read more link that opens a relevant MSDN article for system symbols.

  • The go to link that brings you to the symbol declaration either in the editor for solution items or in your preferred way for compiled library items.

tip

In the Quick Documentation popup, you can also Ctrl +click any hyperlink to go to the declaration of the corresponding symbol instead of opening its documentation.

For overridden and implemented members, the following convention applies:

• If an overriding/implemented member does not have comments but its base member does, base member comments are shown.

• If they both have comments, those of the overriding/implemented member are shown.

tip

That's where the Copy comments from base context action comes in handy — when the caret is upon an overriding/implemented member name, you can copy member documentation from its base class/interface. This context action works for properties, indexers and methods.

This feature is supported in the following languages and technologies:

The instructions and examples given here address the use of the feature in C#. For details specific to other languages, see corresponding topics in the ReSharper by language section.