R
Ray Cassick \(Home\)
I have been using XML Comments in VB.NET during my time with VS.NET 2003
thanks to VBXC and NDoc. I just started to upgrade one of my projects into
VB.NET 2005 and am seeing some odd errors centered around my past use of XML
comments. I am interested to know if you all think this is a bug or 'working
as designed' and I was just lucky to get away with it.
I had a method that could, based upon two different cases throw an
ArgumentException. I had commented it this way:
''' <summary>
''' Allows the caller to get the name of a wizard form with its index
number.
''' </summary>
''' <param name="pageNumber">Integer value indicating the wizard page to
reference.</param>
''' <returns>The name string of the wizard page at the referenced
index.</returns>
''' <exception cref="ArgumentException">Will be thrown if the pageNumber is
less than zero.</exception>
''' <exception cref="ArgumentException">Will be thrown if the pageNumber is
greater than the number of pages contained in the collection.</exception>
VS.NET 2005 now complains of the following:
XML comment tag 'exception' appears with identical attributes more than once
in the same XML comment block. XML comment will be ignored.
Seems to me this is a bug in the XML comments engine. NDoc creates a table
showing each exception you can get and the reason why it would be thrown.
This table allows (as does the NDoc schema apparently) for exceptions of the
same type but different reasons.
Anyone here care to comment on their thoughts? I have not tried the same
thing in C# so I am not sure if it would work differently there or not.
--
Raymond R Cassick
CEO / CSA
Enterprocity Inc.
www.enterprocity.com
3380 Sheridan Drive, #143
Amherst, NY 14227
V: 716-316-5973
Blog: http://spaces.msn.com/members/rcassick/
thanks to VBXC and NDoc. I just started to upgrade one of my projects into
VB.NET 2005 and am seeing some odd errors centered around my past use of XML
comments. I am interested to know if you all think this is a bug or 'working
as designed' and I was just lucky to get away with it.
I had a method that could, based upon two different cases throw an
ArgumentException. I had commented it this way:
''' <summary>
''' Allows the caller to get the name of a wizard form with its index
number.
''' </summary>
''' <param name="pageNumber">Integer value indicating the wizard page to
reference.</param>
''' <returns>The name string of the wizard page at the referenced
index.</returns>
''' <exception cref="ArgumentException">Will be thrown if the pageNumber is
less than zero.</exception>
''' <exception cref="ArgumentException">Will be thrown if the pageNumber is
greater than the number of pages contained in the collection.</exception>
VS.NET 2005 now complains of the following:
XML comment tag 'exception' appears with identical attributes more than once
in the same XML comment block. XML comment will be ignored.
Seems to me this is a bug in the XML comments engine. NDoc creates a table
showing each exception you can get and the reason why it would be thrown.
This table allows (as does the NDoc schema apparently) for exceptions of the
same type but different reasons.
Anyone here care to comment on their thoughts? I have not tried the same
thing in C# so I am not sure if it would work differently there or not.
--
Raymond R Cassick
CEO / CSA
Enterprocity Inc.
www.enterprocity.com
3380 Sheridan Drive, #143
Amherst, NY 14227
V: 716-316-5973
Blog: http://spaces.msn.com/members/rcassick/