2 ms·
I use a plugin for Visual Studio that lets me add an image to comments and it’s wonderful even if it is a bit janky. If you don’t have the plugin, you still see
by criddell 4y ago
I use a plugin for Visual Studio that lets me add an image to comments and it’s wonderful even if it is a bit janky. If you don’t have the plugin, you still see a reference to an image file that you can click on to load in an external viewer and this a decent fallback.
I don’t know why this hasn’t become a standard feature of IDEs and editors.
- JohnFen 4y agoI would hate this so much! I can see how an actual image is useful in certain circumstances, but I wouldn't want it to appear in the code itself. Just include the image in the documentation folder and refer to it in the code by name.
- criddell 4y agoIt's been invaluable to me in a few circumstances. A common one is when there is a diagram of a physical object with dimensions and the dimensions are used in the code. For example, say you are doing a volume calculation of a complex enclosed space that uses quantities like length, height, clearance, diameter, etc... A diagram illustrating what those dimensions are can aid immensely in understanding the code.
- JohnFen 4y agoOh, sure, it can be extremely helpful. A picture is worth a thousand words and all of that. I just don't want that picture in-line with the code. It bulks up the view of the code and I'd want the picture in a separate window anyway, to refer to it as I'm scrolling through the code itself.