ImageComments (a Visual Studio Extension)
This fork is an updated version with all sound patches from the different forks out there. all sound patches from the different forks out there.
This is an extension for the Visual Studio code editor that allows images to be displayed amongst code, allowing for visually rich comments. For example...
Disclaimer: This project is a WIP and it's pretty rough around the edges. Please report issues on the GitHub repo.
Supported Visual Studio Verions 2010~2015 (2017 warns about missing support, but works)
To install double-click/activate the VSIX file.
How to use
Image-comments are declared with:
You can use the VS environment variables $(ProjectDir), $(SolutionDir), and $(ItemDir) in URLs, e.g.:
From 22.214.171.124 on you can also use relative paths (relative to the source file).
Images from URL will be downloaded and not updated as long as the file exists in the user temp directory.
Please note, if you use docfx at the same time, these environment variables must not be used, because docfx expects the images in a directory, e.g. "./images".
Images are displayed using the WPF Image control with a BitmapFrame source, and accepted image and URL formats are tied to those, e.g. BMP, PNG, JPG all work as image formats, and C:\Path\To\Image.png, http://www.server.com/image.png and \\server\folder\image.png all work as URLs.
If there's a problem trying to load the image or parse the tag, the tag will be squiggly-underlined and hovering over this will show the error, e.g
The languages currently supported are Python, C#, F# (fixme), C, C++ and VB.
Image-comments don't really have anything to do with XML comments, but the format is convenient and it should be pretty straight-forward to transform them for Sandcastle documentation creation.
The extension adds a command in the Tools menu to toggle image-comment display on or off.
In VS, open the Extension Manager, select ImageComments, then click uninstall. A restart of VS is required.
Some known issues
Requires: Visual Studio 2015 SDK
Providing the VS SDK is installed, you should be able to build by opening the solution and hitting F6. Debugging has to be configured manually - On the Project Properties->Debug tab, choose 'Start External Program' and command line e.g. (if using default install location) 'C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\devenv.exe' with arguments '/rootsuffix Exp'. The 'Release' build configuration copies the .vsix package into the Solution's .\Output directory.
It's a very small project and may be fairly self explanatory if you are familiar with Visual Studio editor extensions. There are two components to the extension:
For testing information, see .\Testing\Testing.html
Some known implementation issues
The code is a bit rough - it may not need a rewrite from scratch, but there's a bunch of stuff to be done
Eclipse Public License v1.0. See license text for details.
The original plugin was made by Luke McQuade, this fork is maintained by Thomas Pollak. Further contributors: Lionsoft, Oleg Kosmakov, Morten Engelhardt Olsen, Wolfgang Kleinschmit, Sören Nils Kuklau, Tim Long