Re: XML Comment Screwed - Possibly a bug in VB??

Well some people have the option on in the ide that Warning=error ( just
for the simple fact that a warning then blocks a built until you solved the
issue )
so maybe he wasn`t aware :-)

I guess that a lot of coders are not aware of the fact that the
documentation is in fact true XML that has a use on its own and can even be
used in externall reporting and tracking tools such as Ghostdoc , Sandcastle
etc etc etc

regards

Michel



"Stephany Young" <noone@localhost> schreef in bericht
news:eFMJuTszIHA.3680@xxxxxxxxxxxxxxxxxxxxxxx
Yes, certainly the user made an error, but the point is that VS reported a
warning and not an error.


"Michel Posseth [MCP]" <MSDN@xxxxxxxxxxx> wrote in message
news:u99HNHszIHA.4816@xxxxxxxxxxxxxxxxxxxxxxx
Well in fact it is an error Stephany ,, but not an error of the
system but an error of the person who wrote the comment :-)
as XML follows the same rules as HTML for special characters , it seems
that this person wasn`t aware of this fact
the systems just warns that the XML doc will be broken


regards
michel




"Stephany Young" <noone@localhost> schreef in bericht
news:uh%23yVlozIHA.2292@xxxxxxxxxxxxxxxxxxxxxxx
1. It's NOT an error - It is a warning!
They are totally different things.

2. & is the escape character in XML.
If you wish to include an & in XML then you need
to specify it as &amp;


"Siv" <g@xxxxxxxxxxxxxxxxxxxxxxxx> wrote in message
news:0CF67692-E4BF-487D-B96C-C794E7785FAD@xxxxxxxxxxxxxxxx
Hi,

Just busily coding away and removed a procedure from my code and all of
a sudden an error came up miles away from the location of the piece of
code I removed and it relates to the XML comment inserted at the top of
the procedure.

I had this happen once before and I couldn't fathom why it was
complaining, the XML comment is like this:

''' <summary>
''' If the Bonds flag is set in the security record we have at least
one Bond & Floating Charge
''' This routine locates the bonds that are linked to the Security
Record and adds them as sub nodes to
''' the main Bonds node.
''' </summary>
''' <param name="ParentNode"></param>
''' <remarks></remarks>

This gives an error:

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

I then discovered if I remove the "&" ampersand symbol the error
message goes away???

Is this a "by design" thing or is this a bug in the XML comments??

Siv








.

Relevant Pages

  • Re: XML Comment Screwed - Possibly a bug in VB??
    ... internal workings of XML. ... being that if another VB user like me who doesn't know why this "warning" ... perhaps tighten up the warning messages so that the warning message can ... ''' If the Bonds flag is set in the security record we have at ...
    (microsoft.public.dotnet.languages.vb)
  • Re: XML Comment Screwed - Possibly a bug in VB??
    ... I didn't come here to be scolded for not understanding the internal workings of XML. ... My hope being that if another VB user like me who doesn't know why this "warning" comes up and doesn't know how to get past it will read my post and get a resolution to the problem. ... I also hoped that one of the developers from Microsoft may become aware of it and perhaps tighten up the warning messages so that the warning message can be a bit more focused on what is really upsetting it. ... ''' If the Bonds flag is set in the security record we have at least one Bond & Floating Charge ...
    (microsoft.public.dotnet.languages.vb)
  • XML Comment Screwed - Possibly a bug in VB??
    ... Just busily coding away and removed a procedure from my code and all of a sudden an error came up miles away from the location of the piece of code I removed and it relates to the XML comment inserted at the top of the procedure. ... ''' If the Bonds flag is set in the security record we have at least one Bond & Floating Charge ... ''' This routine locates the bonds that are linked to the Security Record and adds them as sub nodes to ...
    (microsoft.public.dotnet.languages.vb)
  • Re: XML Comment Screwed - Possibly a bug in VB??
    ... Don`t get upset about postings in the groups,, some people over here are ... internal workings of XML. ... perhaps tighten up the warning messages so that the warning message can be ... ''' If the Bonds flag is set in the security record we have at ...
    (microsoft.public.dotnet.languages.vb)
  • Re: XML Comment Screwed - Possibly a bug in VB??
    ... I didn't come here to be scolded for not understanding the internal workings of XML. ... My hope being that if another VB user like me who doesn't know why this "warning" comes up and doesn't know how to get past it will read my post and get a resolution to the problem. ... I also hoped that one of the developers from Microsoft may become aware of it and perhaps tighten up the warning messages so that the warning message can be a bit more focused on what is really upsetting it. ... ''' If the Bonds flag is set in the security record we have at least one Bond & Floating Charge ...
    (microsoft.public.dotnet.languages.vb)
Loading