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 50.1 summarizes recommended tags.

Table 50.1 Recommended Tags for XML Comments

image

Case-Sensitiveness

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

Note on Complex Documentation

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

Get Visual Basic® 2010 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.

Start your free trial