Categories
C# VB.NET Visual Studio XML

XML documentation parse error (warning in Visual Studio)

I was working with a VB.NET project today and noticed the following warning:

XML documentation parse error: Whitespace is not allowed at this location. XML comment will be ignored.

After a quick search on the web I found the problem was using the ‘&’ character which is a reserved character for XML documentation. So my solution was to change ‘&’ to ‘and’ but I also found that placing the comment inside of <![CDATA[ Comments ]]> works. Here’s an example of my comment:

''' 
''' This is a comment with an ampersand & causes a warning in Visual Studio.
''' 
''' 
''' 
''' 
Public Property s1() As String
	Get
		Return ""
	End Get
End Property