Pycharm tutorial (25) – View the help documentation for the Pycharm editor feature

1. Preparation

Pycharm version 2.7 or higher

(2) Be consistent with product documentation notes

(3) You have created a project and added at least two script files to it. See Getting Started

2. Quickly review the definition

When you just want to know the relevant declaration information, use Quick Definition without jumping to the actual definition location. For example, place the cursor on an expression and select View→Quick Definition from the main menu:

You can see the relevant quick definition information in the pop-up window, and then use the arrow keys to move through the prompt.

Click the button to Find quick definition information in the Find Tool Window:

3. Take a quick look at the help documentation

The shortcut (help) document displays the documentation comment for the current symbol, along with the associated comment character. Again, we position the cursor on an expression, this time using the menu command View→Quick Documentation.

In the popup window, we can also browse the document information through the left and right arrow keys:

Of course we can resize the popover. Click on the pop-up size adjustment scroll bar and drag the slider to change the current size:

Click the button to open the quick help document in the Documentation Tool Window:

Click to restore the window to its original form.

4. Review external documentation

This command allows you to view the details of the help document in the default browser:

Incidentally, you can open external help documents through the Quick Documentation pop-up window by clicking or pressing the Shift+F1 shortcut key.

External documentation uses third-party libraries such as PyQt4, PySide, GTK, WX, Numpy, Scipy, and Kivy as default versions. If you want to view help documentation in other versions, such as Pyramid, Refer to Python External Documentation for reference.

5. View the parameter information

This command displays parameter information for a function method:

6. View the environment context information

Finally, you can view the specific symbol information at the beginning of the code block through a pop-up window. For example, we position the cursor on an Exception where the function declaration is outside the current visual editing range, and then press Alt+Q or View→Context Info menu command:

This post is from SDK Community (www.sdk.cn/).