Display code documentation in real time in the VS Code sidebar. Currently supports Java / TypeScript / JavaScript / Markdown, with bidirectional synchronized navigation.
Marketplace: comment sidebar
Author: dawdadsd
- Click a method/function in the sidebar -> jump to the corresponding location in code
- Move the cursor in code -> the sidebar automatically highlights the current method/function
- Compact mode: quickly browse the member list
- Detailed mode: show complete documentation details
- Return types and parameter types are highlighted
- Tags such as
@param,@return,@throwsare shown in table format - Can display Git author and last modified time (based on
git blame/git log)
Demo for Markdown docs
Demo for Java code:
showLock: true
The same applies to TS and JS code.
When retrieving author/last modified information, this extension directly calls system git commands (such as git blame / git log) and does not rely on any extra VS Code Git extension.
- macOS: Git is usually preinstalled or already available, so author info can be displayed normally.
- Windows: You need to install Git for Windows and ensure
gitis in PATH. Also, the current file must be inside a valid Git repository (with available.githistory).
- Open any Java / TypeScript / JavaScript file
- Click the Doc Sidebar icon in the left activity bar
- View method/function documentation in the sidebar
- Click a method/function name to jump to its code location
| Setting | Type | Default | Description |
|---|---|---|---|
javaDocSidebar.enableAutoHighlight |
boolean | true | Enable reverse highlight when moving the code cursor |
javaDocSidebar.debounceDelay |
number | 300 | Debounce delay for reverse highlight (milliseconds) |
javaDocSidebar.maxMethods |
number | 200 | Maximum number of methods shown in the sidebar |
- VS Code 1.95.0 or later
- When parsing Java files, installing a Java language support extension is recommended (for better Symbol parsing)
This project is released under the MIT License. See LICENSE for details.