Accessing Help in a VEX VS Code Project

When developing a VEX Project in the VS Code Editor area, we can access documentation for a specific function included in the C++ and Python API (Application Programming Interface) through VEX Command Help or Tooltip Hint. This documentation helps us understand the structure and usage of the function, and assist us with debugging. The documentation is specific to each VEX Platform(IQ 2nd, EXP, V5).

Accessing VEX Command Help

  • Highlight the text of the function that you want to know information about, and right-click the mouse on the selected text.

    Screenshot of the VEX V5 Code Extension interface in Visual Studio Code, showcasing features and tools available for programming VEX robotics.
  • The Context Menu will prompt. Click on the VEX Command Help item.

    Screenshot of the VEX V5 VS Code Extension interface, showcasing various coding features and tools available for programming VEX robotics.
  • If VEX Command Help finds an exact match, the VEX Command Help window will prompt with relevant documentation.

    V5 Category Description - VS Code Extension: Screenshot showing the user interface of the VEX V5 Code Extension, highlighting features and tools available for programming VEX robotics.
  • If VEX Command Help finds multiple documents that match the selected text, the VEX Command Help Drop-down Menu will prompt with a filtered list of the relevant functions.

    Screenshot of the VEX V5 Code Extension interface in Visual Studio Code, showcasing features and options available for programming VEX robotics.
  • (Optional) Type the keyword of the specific function in the Text Box if you want to filter the relevant functions.

    V5 Category Description: Visual Studio Code Extension interface screenshot showing features and functionalities, including code editing tools and extensions available for VEX robotics development.
  • Click on the list item of the specific function that you want to know information about.

    Screenshot of the VEX V5 Code Extension interface in Visual Studio Code, showcasing features and tools available for programming VEX robots.
  • The VEX Command Help window will prompt with relevant documentation.

    Screenshot of the VEX V5 Code Extension interface in Visual Studio Code, showcasing key features and layout for programming VEX robotics.

Accessing Tooltip in VS Code

  • Hover the mouse over the text of the function you want to know information about. 

    Screenshot of the VEX V5 VS Code Extension interface, showcasing key features and options for programming VEX robots, including code editing, debugging tools, and project management.
  • The Tooltip Box will pop up with the information on the specific function.

    Diagram illustrating the features and functionalities of the VEX V5 Code Extension for VS Code, highlighting its integration with VEX robotics programming tools.

For more information, help, and tips, check out the many resources at VEX Professional Development Plus

Last Updated: