ReSharper 2021.1 Help

Quick Documentation

ReSharper | Edit | Show 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.

View quick documentation for a symbol

  1. Set the caret

    • at a symbol in the editor,

    • at a symbol in the File Structure window or any other ReSharper tool window,

    • anywhere within a documentation comment.

  2. Press Control+Q or choose ReSharper | Edit | Show Quick Documentation… from the main menu. Alternatively, you can press Control+Shift+A, start typing the command name in the popup, and then choose it there.

  3. In the Quick Documentation popup that appears, you can study symbol documentation and follow hyperlinks to view related documentation.

    Quick documentation popup

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:

Choosing the target for quick documentation

Additional capabilities of the Quick Documentation popup include:

  • Pin window button Themed icon pin screen gray 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.

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.

This feature is supported in the following languages and technologies:

Language: C#Language: VB.NETLanguage: C++Language: HTMLLanguage: ASP.NETLanguage: RazorLanguage: JavaScriptLanguage: TypeScriptLanguage: CSSLanguage: XMLLanguage: XAMLLanguage: ResxLanguage: Build ScriptsLanguage: ProtobufLanguage: JSON
Feature is available in C#Feature is available in Visual Basic .NETFeature is available in C++Feature is available in HTMLFeature is available in ASP.NETFeature is available in RazorFeature is available in JavaScript Quick documentation in TypeScriptFeature is available in CSS Feature is not available in XMLFeature is available in XAMLFeature is available in Resource filesFeature is available in build script files Feature is not available in ProtobufFeature is available in JSON

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.

Last modified: 08 March 2021