Sometimes you may want to insert images in your documentation, e.g. screenshots of the forms.

If you are using XML comments, you can add images with <img> tag. The best way is to use comment editor.

If you are using @-style comments, you can do this by $IMG$ and $GMI$ macros directly in the comments.

'**
'@rem This is image $IMG$myImage.gif$GMI$
'
Function method1(ByVal x As Integer) As Boolean

Enter file name of the picture you want to include between $IMG$ and $GMI$ macros. Image will appear in resulting documentation on the place of calling those macros, exactly like this logo.

All image files should be located in your folder for external files. They must be distributed together with documentation file as well, except for HTML Help (CHM) and Help 2 (HxS) formats. CHM and Help 2 formats contain all images packed in its file so you do not need to distribute images separately.

See Also

<img> Tag | Using Macros Directly in Comments | Adding External Files in Documentation