Defining Complex Code Documentation

The MSDN documentation says that the Visual Basic compiler can parse any valid XML tag. The MSDN also recommends a series of tags that are specific to the code documentation. Table 47.1 summarizes the recommended tags.

Image

TABLE 47.1 Recommended Tags for XML Comments

Case-Sensitivity

Tags within XML comments are case-sensitive and lowercase. Take note of this to ensure that the Visual Basic compiler correctly recognizes tags.

Note on Complex Documentation

You can appreciate complex documentation generated with XML comments only when building compiled help files. This is because within IntelliSense or in the ...

Get Visual Basic 2015 Unleashed now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.