Use DeepDoc

Use DeepDoc

VS Code extension

Explain selected code inline, and insert generated comments above it.


A separate extension from the CLI, for the other half of the job: explaining code while you are reading it, rather than documenting a whole repository.

Select some code, ask for an explanation, and optionally have the comment inserted above the selection.

Install

The extension lives in vscode-extension/ in the repository and ships on its own release track, independent of the Python package.

cd vscode-extension
npm install && npm run package
code --install-extension deepdoc-*.vsix

Using it

Select code, then either hover for the DeepDoc · Fast | Deep actions or use a shortcut:

ModemacOSWindows / Linux
FastCmd+Alt+ECtrl+Alt+E
DeepCmd+Alt+DCtrl+Alt+D

Fast is a quick single-pass explanation. Deep spends longer and reasons further for code that needs it.

Commands

From the command palette:

Command
DeepDoc: FastExplain the selection quickly
DeepDoc: DeepExplain it thoroughly
DeepDoc: Test ConnectionCheck your provider and key work
DeepDoc: Set API KeyStore a key securely
DeepDoc: Clear API KeyRemove it

Settings

Provider

deepdoc.provider · deepdoc.baseUrl · deepdoc.fastModel · deepdoc.deepModel, plus deepdoc.azureApiVersion and deepdoc.azureDeploymentName for Azure.

What gets sent

deepdoc.maxSelectedLines caps the selection size; deepdoc.includeContextLines adds surrounding lines for context. Both control how much of your code leaves the editor.

What gets inserted

deepdoc.includeMetadataHeader, deepdoc.includeMarkers and deepdoc.replaceExistingBlock control the shape of the inserted comment and whether re-running replaces a previous block rather than stacking.

Limits

deepdoc.timeoutMs, deepdoc.fastMaxTokens, deepdoc.deepMaxTokens.

Edit this page on GitHub