AI Assistant
When working in DVT IDE, you can automatically generate comments for your code using the DVT AI Assistant.
1. Open the Specador HTML Preview, by placing the cursor on an element declaration (e.g., module, interface, class, entity, unit),
then Right-Click and choose .
2. Simply press the
button next to a variable, function, port, signal etc. to generate missing comments using AI.
To generate all missing comments press the Generate missing comments button, located in the top-right corner.
After reviewing the generated comments you can re-generate, manually adjust or discard them altogether.
Hover an AI-generated comment to reveal the regenerate and discard buttons.
Click an AI-generated comment to open the inline Markdown editor. The toolbar provides typical text formatting assistance (bold/italic, bullet lists, headers, quote etc).
When done, press
to save the changes. A diff editor will present all changes to source code comments.
Using the AI Assistant helps accelerate documentation while keeping you in full control of the final content.
Attention
AI-generated comments may include mistakes, always review the content to ensure it matches your design intent.
Note
The AI-generated comments follow a set of instructions called Blueprints.
To review or edit the blueprint, use the command DVT AI: Edit Predefined Blueprint and select Add comment to the Specador Preview.
After you customize the blueprint and save it, the preview will use of the new instructions. More information about customized blueprints here.