With JetBrains Rider, 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).
tip
You can copy the full contents of the Quick Documentation popup by Alt-clicking it (CtrlAlt-clicking it if you are on Linux).
By default, the Quick Documentation popup appears when you hover over any symbol. If you want to disable that and always invoke the popup explicitly, click in the popup and then click Show on mouse move or alternatively, clear the Show quick documentation on hover checkbox on the Editor | Code Editing page of JetBrains Rider settings CtrlAlt0S. Explicit invocation will be available regardless of this option. If you prefer to see Quick Documentation on mouse hover, you can configure the appearance delay (in milliseconds) in the Tooltip delay field on that settings page.
View quick documentation for a symbol
Place the caret
at a symbol reference in the editor,
anywhere within a documentation comment.
Press Ctrl0K,0I or choose View | Quick Documentation from the main menu. Alternatively, you can press Ctrl0Q, start typing the command name in the popup, and then choose it there.
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:
When you type a method call without parentheses and then invoke Quick Documentation, JetBrains Rider will let you choose a method signature to study if the method has multiple signatures:
tip
If you are studying a function call, you can also invoke Parameter Information to view the list of overloads of the function — press CtrlShiftSpace when your caret is within the call parentheses.
Additional capabilities of the Quick Documentation popup include:
A settings button , that provides various options for adjusting the popup as well as navigation to the documented symbol F4.
Browser-like back/forward navigation buttons in the top left corner of the popup. These buttons appear when you choose to display the toolbar in the popup.
Hyperlinks that let you navigate to documentation for related entities, including the to the Microsoft Docs article for system symbols.
By default, JetBrains Rider shows Quick Documentation in a popup; to view it in the tool window, click in the popup and choose Open in Documentation Tool Window or press Ctrl0K,0I twice.
When JetBrains Rider 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.
tip
That's where the Copy documentation from basecontext 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.
Cookie Settings
Our website uses some cookies and records your IP address for the purposes of accessibility, security, and managing your access to the telecommunication network. You can disable data collection and cookies by changing your browser settings, but it may affect how this website functions. Learn more.
With your consent, JetBrains may also use cookies and your IP address to collect individual statistics and provide you with personalized offers and ads subject to the Privacy Notice and the Terms of Use. JetBrains may use third-party services for this purpose. You can adjust or withdraw your consent at any time by visiting the Opt-Out page.