With ReSharper you can quickly review the documentation on a symbol in your code. The quick documentation popup is available for types, methods and keywords. It includes reference information such as:
- attribute values;
- the full type/method signature;
- documentation summary (documentation comments);
- documentation on parameters;
- return value documentation;
- exceptions documentation.
To display the Quick Documentation Popup:
- Position the caret on a symbol;
- Press Ctrl + Q or select ReSharper | Code | Quick Documentation in the main menu.
While viewing a documentation popup, you can:
- Click hyperlinks to navigate to corresponding types (will be opened in the same popup window);
- Scroll and resize the popup as needed.
Example 1: Type
Press Ctrl + Q to display the following popup:
Example 2: Method
Press Ctrl + Q to display the following popup:
Note You can also preview the documentation popup for the documentation comments you are currently typing. Press Ctrl + Q anywhere within the comments.