With ReSharper, you can quickly review the documentation on a symbol in the code. Clickable links help you navigate to related documentation or code.
Position the caret:
- At a symbol in the editor.
- At a symbol in the File Structure or any other ReSharper tool window.
- Anywhere within a documentation comment.
On the main menu, choose
ReSharper | Edit | Show Quick Documentation
pop-up window will display:
- Follow hyperlinks to view related documentation.
Additional capabilities of the Quick Documentation pop-up window include:
- Pin window button that comes in handy whenever you need to preserve the contents of the Quick Documentation window before switching back to the editor. After you click this button, the window 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 window.
Hyperlinks that let you navigate to documentation for related entities, including:
- read more link that opens a relevant MSDN article in Microsoft Document Explorer whenever documentation for a symbol contains more than a mere summary.
- go to link that navigates you to a symbol declaration either in the editor or in Object Browser .
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 doesn't 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.
That's where the Copy comments from base context action comes 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/technologies:
The instructions and examples given here address the use of the feature in C#. For details specific to other languages, see the corresponding topics in the ReSharper by Language section.