Skip to content

About

Render Doc Comments provides a beautiful, interactive preview of your documentation that respects your IDE theme. Choose between Caret-based auto-hiding or a Premium Margin Glyph toggle. Includes clickable cref links and customizable accent bars. Lightweight and native feel.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Latest commit

 

History

39 Commits

Folders and files

Repository files navigation

Visual Studio

💎 Render Doc Comments: Modernize Your Workspace

Stop reading raw XML. Start seeing your documentation.

Render Doc Comments is a high-performance Visual Studio extension that transforms cluttered documentation comment tags into clean, beautifully formatted documentation blocks—instantly. It's designed to stay out of your way when you're coding and provide total clarity when you're reviewing.


✨ The Interactive Experience

Writing documentation shouldn't feel like looking at a configuration file. Our extension offers powerful, flexible ways to manage your workflow:

  1. Caret-Based Mode (Default): The second you click into the comment, it reverts to raw XML for zero-friction editing. Move your cursor away to see the polished preview.
  2. Margin Glyph Mode (Premium): Prefer manual control? Use the dedicated Margin Glyph toggle to switch between raw XML and rendered docs regardless of where your cursor is.
  3. Comment Tag Rendering: Drop a TODO, FIXME, or WARN into any comment and it's instantly rendered as a colour-coded badge inline — no more scanning walls of text for the flags that actually matter.
  4. Comment Tags Explorer: A dedicated tool window rolls up every tagged comment across your solution into one searchable view, grouped by tag or by file, so you can jump straight to any TODO without hunting through the codebase.
  5. Scroll Bar Tag Markers (Premium): Coloured indicator tick marks appear on the editor scroll bar for comment tags, allowing instant visual navigation with a single click.
  6. Comment Boxes & Section Banners (Premium): Wrap plain // comments into styled boxes or collapse section divider comments and #region blocks into clean, modern visual header bars.

Before

image

After

Screenshot 2026-03-23 002602
Screenshot 2026-03-23 002632
Screenshot 2026-03-23 002521
Screenshot 2026-03-23 003032
image
image
image
image

⚙️ How to Customize

Access all your settings and Premium features via: Extensions > Render Doc Options

Access Comment Tags Explorer via: View > Other Windows > Comment Tags Explorer

From here, you can toggle between Caret-based hiding and Margin Glyph control, customize your typography, configure scrollbar markers, adjust your accent bar styles, and configure comment boxes and header banners.


🛠 Feature Comparison

Feature Free Edition Premium License
Multi-Language Support (C#, F#, C++, VB.NET) ✅ ✅
High-Fidelity Rendering ✅ ✅
Interactive cref Links ✅ ✅
Per-File Toggle (Toolbar Button & Context Menu) ✅ ✅
Viewport Pre-Rendering (Large File Performance) ✅ ✅
Caret-Based Auto-Hide ✅ (Always On) 🔘 Selectable
Margin Glyph Toggle ❌ 🔘 Selectable
Theme Synchronization Manual (Reopen File) ⚡ Instant Auto-Sync
Rendered Comment Fixed Width Only Auto-width 🔘 Selectable
Rendered Comment Use Custom Fixed Width ❌ ⚙️ Customizable
Typography (Doc Comments) Segoe UI (Fixed) 🎨 Fully Custom
Accent Bars Left Side Only 🔥 Multi-side Layout
Color Profiles & Gradient Presets Default 🌈 Full Customization & Presets
Comment Tag Render ✅ ✅
Comment Tag Render Style (Pill/Card) 🔘 Selectable 🔘 Selectable
Comment Tag Typography Editor Font (Fixed) 🎨 Fully Custom
Tag Comments Render Color Default 🌈 Full Customization
Per-Tag Visibility Toggle All Tags Enabled 🔘 Selectable
Scroll Bar Tag Markers ❌ ✅ Interactive Markers
Comment Tags Explorer Tag Explorer Tag + File Explorer
Comment Boxes (plain // comments) ❌ ✅ Premium
Banner Comments (section header bars) ❌ ✅ Premium
#region Directive Banners ❌ ✅ Premium
Box & Banner Styling (Fonts, Rules, Heights, Colors) ❌ ⚙️ Fully Customizable

🎨 Professional Aesthetics

Built to feel like a native part of the IDE, the extension uses a signature Purple Gradient accent to define your documentation boundaries.

  • Theme Agnostic: Whether you use Dark, Light, or a custom community theme, the background matches perfectly.
  • System Native: Uses Windows default font styles (Free) or your own choice (Premium) to ensure your IDE stays lightweight and crisp.

🚀 Getting Started

  1. Pre-requisite: Download and install .net Framework v4.7.2 or above.
  2. Install: Download from the Marketplace and restart Visual Studio (VS2022, VS2026).
  3. Open: Any C#, F#, C++, or VB.NET file with standard documentation comments.
  4. Enjoy: Your documentation will render automatically.

⚖️ Licensing & Open Source

This project is proudly licensed under GNU GPL v3. We believe in open-source transparency. The core rendering engine is free for everyone, while Premium features support the continued development of the tool.


Elevate your code readability today — across every language in your solution.

About

Render Doc Comments provides a beautiful, interactive preview of your documentation that respects your IDE theme. Choose between Caret-based auto-hiding or a Premium Margin Glyph toggle. Includes clickable cref links and customizable accent bars. Lightweight and native feel.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages