Friday, 16 February 2007

XML Comments in VB.NET


With the introduction of Visual Studio 2005, Microsoft have added the XML Comments system to VB.NET, so it is now possible to fully document VB.NET source code using the XML Comments technique that was previously only possible to utilise in C#. Thank you Microsoft!

Version 8.0 of the .NET Documentation Tool will support XML Comments in VB.NET as well as C#. This makes it possible to produce much higher quality documentation for VB.NET, so start adding XML Comments to your VB.NET code today!

P.S. If you're using Visual Studio 2005 it's easy - just type three single quotes above a class, function or property declaration and Visual Studio will automagically create an XML Comment template for you to complete.

XML Comments are also used by the Intellisense autocomplete system, so they're well worth using!