Interactive Onboarding Tooltips & AI Helper for Visual Studio

This is an extension designed to assist developers navigating a new codebase by serving context-aware guidance directly inside the code editor without directly adding comments to the source code. It matches active lines of code with detailed documentation stored in a local project report file, and integrates with AI chat tools to generate or update missing information so to give useful insight.

Features

1. Context-Aware Onboarding Tooltips

When hovering over lines of code, the extension dynamically parses the active scope (methods, classes, namespaces, or top-level statements) and checks for corresponding entries inside a local guide file named [ProjectName]Report.txt.

• If a match is found, the custom developer documentation and comments are displayed immediately within the QuickInfo tooltip.
• Helps orient new team members without requiring them to search through the entire code base to find what a line is doing and some context behind that.

2. Instant AI Integration ("Fix Line" / "Fix Block")

If an area of code lacks detailed documentation or requires an update:

• Click the Fix Line or Fix Block hyperlink embedded directly inside the tooltip.
• The extension automatically formats a structured, context-aware prompt containing the target code block, active scopes, and instructions.
• It sends this structured context directly to your open AI chat window in Visual Studio via keyboard simulation (Alt + /), prompting the AI to write or update the required documentation schema.

3. Support for Multiple Scopes

The tool handles granular line-by-line tooltips as well as container-level blocks (such as entire local functions, classes, or nested statements), letting you build out document templates ranging from simple methods up to full namespaces.

How It Works

1. Guide Parsing: The extension looks for a file named [ProjectName]Report.txt in your project directory. It parses documentation structured between vvvCODEvvv and ^^^CODE^^^ blocks.
2. Matching: The parser normalizes code lines and scopes to ensure accurate matching, even when spacing or modifiers vary.
3. Tooltip Delivery: On hover, the associated comments are pulled from the report file and presented to the developer.
4. On-the-Fly Generation: Clicking the helper links inside the tooltip triggers a background automation sequence that feeds the correct documentation template straight to your AI companion.

WARNING if you have changed your keybinds then it may not work or if you don't have the GitHub Copilot installed then it will not work as well.

License

Apache 2.0