Hints Viewer

[中文]

This feature enhances your development experience by providing helpful hints for errors detected in your code.

The idf.py tool suggests hints for resolving errors. Starting from ESP-IDF v6.0, an aggregated hints.yml is generated under the project build directory (idf.buildPath) during CMake configuration. The extension prefers this file when present and falls back to the legacy $IDF_PATH/tools/idf_py_actions/hints.yml for older versions. Hints will be printed if a match is found for the given error.

Hover Over Errors for Hints

When you hover over errors in the text editor, a hint displays if the error matches one listed in the hints.yml file.

../_images/hover.gif

Bottom Panel for Hints

  1. Automatic Updates: The ESP-IDF bottom panel updates automatically to display hints based on the errors in your currently opened file.

    ../_images/bottom_panel.png

  2. Manual Search: You can manually search for hints by copying and pasting errors.

    ../_images/manual_search.gif