dotPeek 2024.1 Help

Quick Documentation

With dotPeek, you can quickly review the documentation of a symbol right in the code viewer. 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 code viewer,

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

    • anywhere within a documentation comment.

  2. Press Control+Q or choose View | 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.

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 code viewer. After you click this button, the popup float while you work with other 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 .

When dotPeek 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 inspired by and borrowed from JetBrains ReSharper, a developer productivity tool for Microsoft Visual Studio.

Last modified: 15 May 2024