ReSharper 2024.1 Help

Quick Documentation

With ReSharper, you can quickly review the documentation of a symbol right in the editor. If the symbol is documented in a supported format (such as XML-docs for C#), you will see all the documentation with proper formatting. Otherwise, the basic symbol information will be shown (such as full method signature or type visibility and namespace).

Quick documentation popup

View quick documentation for a symbol

  1. Place the caret

    • at a symbol reference 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.

You can invoke Quick Documentation as soon as you have typed a symbol reference, this will help you make sure that you've used the correct symbol. It doesn't have to be a valid statement, a correct symbol name is enough:

ReSharper: Quick Documentation for incomplete code

When you type a method call without parentheses and then invoke Quick Documentation, ReSharper will let you choose a method signature to study if the method has multiple signatures:

Choosing the target for quick documentation

Additional capabilities of the Quick Documentation popup include:

  • Pin window button ThemedIcon.Pin.Screen.(Gray).png 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 float 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 Microsoft Docs 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.

When ReSharper shows Quick Documentation for overridden and implemented members, the following convention applies:

  • If an overriding/implemented member does not have any documentation but its base member does, base member documentation is shown.

  • If they both are documented, the documentation of the overriding/implemented member is shown.

This feature is supported in the following languages and technologies:

Language: C#

Language: VB.NET

Language: C++

Language: HTML

Language: ASP.NET

Language: Razor

Language: JavaScript

Language: TypeScript

Language: CSS

Language: XML

Language: XAML

Language: Resx

Language: Build Scripts

Language: Protobuf

Language: JSON

Feature is available in C#

Feature is available in Visual Basic

Feature is available in C++

Feature is available in HTML

Feature is available in ASP.NET

Feature is available in Razor

Feature is available in JavaScript

Quick documentation in TypeScript

Feature is available in CSS

Feature is not available in XML

Feature is available in XAML

Feature is available in Resource files

Feature is available in build script files

Feature is not available in Protobuf

Feature is available in JSON

The instructions and examples given here address the use of the feature in C#. For more information about other languages, refer to corresponding topics in the ReSharper by language section.

Last modified: 15 May 2024