Skip to content
| Marketplace
Sign in
Visual Studio Code>Programming Languages>JavaDoc Rendered ViewNew to Visual Studio Code? Get it now.
JavaDoc Rendered View

JavaDoc Rendered View

liuhualiang

|
3 installs
| (0) | Free
Eclipse-style Javadoc dock panel for Java sources (including jar sources), with optional LLM translation to Chinese.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

JavaDoc Rendered View

Eclipse-style Javadoc in a docked panel for VS Code and Cursor.

English | 简体中文

Visual Studio Marketplace Open VSX License: MIT

Keep reading Java source in the editor. The member under the cursor is rendered in a Javadoc panel — including project sources and jar / JDT attached sources. Optional LLM translation shows a bilingual view next to the original documentation.

Features

  • Docked Javadoc panel that follows the cursor (bottom panel by default; you can drag it to a sidebar)
  • Renders the current class, method, or field /** … */ with signature and block tags
  • Understands {@code}, {@link}, {@linkplain}, {@literal}, {@value}, HTML entities (—, …), and tags such as @param, @return, @see, @since
  • Clickable links: {@link} / @see / HTML links jump in the editor; external URLs open in the browser
  • Works with jar / jdt dependency sources, not only workspace files
  • LLM translation via any OpenAI-compatible Chat Completions API (OpenAI, DeepSeek, Qwen-compatible endpoints, local Ollama, …)
  • Translation results are cached in extension global storage
  • Status bar JavaDoc item and editor title actions for quick access

Getting started

  1. Install JavaDoc Rendered View from the Visual Studio Marketplace or Open VSX.
  2. Open a .java file (workspace source or attached jar source).
  3. Open the panel with Ctrl+Alt+Q, the book icon in the editor title bar, or View → Open View… → Javadoc.
  4. Move the cursor onto a documented type or member. The panel updates as you move.

Cross-type {@link} navigation works best with Language Support for Java (or equivalent) providing a symbol index.

Optional: translate documentation

  1. Run JavaDoc: Set Translation API Key and paste an OpenAI-compatible API key (stored in Secret Storage, not in settings).
  2. In the Javadoc panel, click 译此块, or run JavaDoc: Translate Current Documentation.
  3. Point javadocRenderedView.translate.baseUrl at your provider if you are not using OpenAI, for example http://localhost:11434/v1 for Ollama.

Commands

Command Description
JavaDoc: Show Javadoc Panel Reveal / focus the Javadoc panel (Ctrl+Alt+Q)
JavaDoc: Translate Current Documentation Translate the current member’s Javadoc
JavaDoc: Translate Current Block Same as above, for the current block
JavaDoc: Set Translation API Key Save the API key in Secret Storage
JavaDoc: Clear Translation API Key Remove the stored API key

Settings

Setting Default Description
javadocRenderedView.renderByDefaultForReadOnly false Auto-reveal the panel for read-only / non-file Java sources (jar / jdt)
javadocRenderedView.translate.baseUrl https://api.openai.com/v1 OpenAI-compatible API base URL (no path beyond /v1)
javadocRenderedView.translate.model gpt-4o-mini Model id used for translation
javadocRenderedView.translate.targetLanguage zh-CN Target language
javadocRenderedView.translate.maxCharsPerRequest 6000 Max Javadoc characters per LLM request (blocks are batched)
javadocRenderedView.translate.includeSurroundingSignature true Include the following declaration line as translation context

Requirements

  • Visual Studio Code or Cursor 1.85.0 or later
  • Java source with Javadoc comments (languageId: java)

This extension renders existing comments. It does not generate comment skeletons or run the JDK javadoc tool to export a site.

License

MIT

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
  • Your Privacy Choices
  • Consumer Health Privacy
© 2026 Microsoft