Use AI prompts to explain and refactor your code

1. Select a code fragment and right-click it to open the context menu.

   Alternatively, select a code fragment and press .

2. Select AI Actions and then Explain Code.

   

   The AI Assistant tool window will open to provide you with an explanation.

   

AI Assistant can help you investigate CMake execution problems.

1. Click Explain with AI in the CMake tool window next to the error message:

   

2. The AI assistant will explain the error for you and suggest how to fix it:

   

1. Select a code fragment and right-click it to open the context menu.

   Alternatively, select a code fragment and press .

2. Select AI actions and then Explain code.

   AI Assistant will analyze and explain the fragment.

   

1. Select a code fragment and right-click it to open the context menu.

   Alternatively, select a code fragment and press .

2. Select AI Actions and then Suggest Refactoring.

   

   The AI chat will open to offer you refactoring suggestions.

   

3. In the field with the refactored code, click See Diff and Apply to open the diff viewer. To skip the diff viewing step, expand the list next to See Diff and Apply and select Apply Immediately.

   In the diff viewer, use Unified or Two-Side view to review the suggested changes.

   

   To apply the suggestion right away, select Apply Immediately:

   

4. If you like the result, click Accept in the gutter to move the selected AI-generated code snippets to the source file, or click Accept all to fully replace the originally selected code fragment. Otherwise, close the diff viewer to skip the suggested refactoring.

1. Select a code fragment and right-click it to open the context menu.

   Alternatively, select a code fragment and press .

2. Select AI Actions and then Find Problems.

   

   The AI chat will open to show the potential issues you may want to look into.

   

1. Click Explain with AI in the console.

   The AI Assistant tool window will open to give you an explanation of the error and suggest a fix.

   

2. If you want to use the suggested fix, click in the field with the refactored code to put the AI-generated code into the editor.

1. Do one of the following:

   • Right-click anywhere in the editor to open the context menu, then go to AI Actions | Edit User Prompts.

   • Press , select AI Actions, and click Add your prompts.

   • Press to open the IDE settings and then select Tools | AI Assistant | User Prompts Library.

2. Click to create a new prompt.

   

3. In the text field, write the prompt.

   If needed, click the $SELECTION variable to add a Markdown-formatted code block with current code selection and language name to the new prompt.

4. Edit the new prompt name.

   Select the first checkbox if you want AI Assistant to wait for you to make additional input in the chat after invoking the prompt.

   Keep the second checkbox if you want your new prompt to be listed in the AI Actions menu.

5. Click Apply.

Once you create a prompt, you can edit or delete it at any time.

note

If you have written a prompt while using the AI Assistant chat, you can save the current prompt by clicking in the chat.