By using this site, you agree to our updated Privacy Policy and our Terms of Use. Manage your Cookies Settings.
440,569 Members | 1,394 Online
Bytes IT Community
+ Ask a Question
Need help? Post your question and get tips & solutions from a community of 440,569 IT Pros & Developers. It's quick & easy.

XML Comment Screwed - Possibly a bug in VB??

P: n/a
Siv
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
Jun 27 '08 #1
Share this Question
Share on Google+
14 Replies


P: n/a
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@removethistextsivill.comwrote in message
news:0C**********************************@microsof t.com...
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

Jun 27 '08 #2

P: n/a
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@localhostschreef in bericht
news:uh****************@TK2MSFTNGP03.phx.gbl...
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@removethistextsivill.comwrote in message
news:0C**********************************@microsof t.com...
>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


Jun 27 '08 #3

P: n/a
Yes, certainly the user made an error, but the point is that VS reported a
warning and not an error.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl...
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@localhostschreef in bericht
news:uh****************@TK2MSFTNGP03.phx.gbl...
>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@removethistextsivill.comwrote in message
news:0C**********************************@microso ft.com...
>>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


Jun 27 '08 #4

P: n/a
Siv
Hi,
Ok "Warning" I must be more precise. However, I think when I am entering a
comment in my code and it "warns" me that "whitespace is not allowed at this
location .." when in fact it should say "Ampersand not allowed in VB
comment" it's more like a bug in VB as it is not telling me the true reason
for the error.

Your response assumes I understand XML which I never use, and have never
really understood why everyone raves about it? It just seems a bit insecure
as a method of holding or transmitting data as it's just plain text that can
be intercepted and read as such. I get the interactivity between systems as
a common data language, but you can achieve the same thing with a flat
file??

Siv

"Stephany Young" <noone@localhostwrote in message
news:uh****************@TK2MSFTNGP03.phx.gbl...
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@removethistextsivill.comwrote in message
news:0C**********************************@microsof t.com...
>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

Jun 27 '08 #5

P: n/a
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@localhostschreef in bericht
news:eF**************@TK2MSFTNGP05.phx.gbl...
Yes, certainly the user made an error, but the point is that VS reported a
warning and not an error.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl...
>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@localhostschreef in bericht
news:uh****************@TK2MSFTNGP03.phx.gbl...
>>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@removethistextsivill.comwrote in message
news:0C**********************************@micros oft.com...
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


Jun 27 '08 #6

P: n/a
Again, by your own words, earlier you were insering an XML comment, so
saying that you didn't know it was XML just doessn't cut it.

It told you the exact reason for the warning, viz. whitespace not allowed at
that location. You had a space character directly following an & character
and that is not allowed in XML.

The use of XML comments, reasonably, expects the author to be able to write
wel-formaed XML. If you are not comfortable with XML then don't use XML
comments.
"Siv" <g@removethistextsivill.comwrote in message
news:26**********************************@microsof t.com...
Hi,
Ok "Warning" I must be more precise. However, I think when I am entering a
comment in my code and it "warns" me that "whitespace is not allowed at
this location .." when in fact it should say "Ampersand not allowed in VB
comment" it's more like a bug in VB as it is not telling me the true
reason for the error.

Your response assumes I understand XML which I never use, and have never
really understood why everyone raves about it? It just seems a bit
insecure as a method of holding or transmitting data as it's just plain
text that can be intercepted and read as such. I get the interactivity
between systems as a common data language, but you can achieve the same
thing with a flat file??

Siv

"Stephany Young" <noone@localhostwrote in message
news:uh****************@TK2MSFTNGP03.phx.gbl...
>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@removethistextsivill.comwrote in message
news:0C**********************************@microso ft.com...
>>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

Jun 27 '08 #7

P: n/a
Ignorance is no excuse.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl...
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@localhostschreef in bericht
news:eF**************@TK2MSFTNGP05.phx.gbl...
>Yes, certainly the user made an error, but the point is that VS reported
a warning and not an error.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl...
>>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@localhostschreef in bericht
news:uh****************@TK2MSFTNGP03.phx.gbl.. .
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@removethistextsivill.comwrote in message
news:0C**********************************@micro soft.com...
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
>
>

Jun 27 '08 #8

P: n/a
Siv
Stephany,
I didn't say I didn't know it was XML I said I didn't "understand" it. I am
aware that the the comments system used by VB.NET uses XML but that doesn't
mean I understand its internal working. You seem to be indicating that I
should? I am aware that my car uses an internal combustion engine but I
wouldn't dare mess with its internal workings or know everything about how
it works. I feel the same about comments. I have always used comments as a
way of letting others (or indeed myself when returning to code I haven't
worked on in a long time), know how a procedure works and any assumptions
that I have made when processing through it.

Using XML in comments was forced on me by MS when they designed the new
commenting system, and don't get me wrong, I like the fact that when I start
to type a call to the commented procedure it starts to tell me the meanings
of the parameters etc. To me this is just a bit of internal working of
VB.NET, not something I can manipulate other than by using its advertised
mechanisms. I have yet to fathom out how I turn these comments into
documentation for my project which I am sure I can do, but have so far been
totally unable to find out how??

To me there is a bug in the parser if it tells a (non XML understanding) VB
user that there is a problem with whitespace in the comment when in fact
it's a problem with you having inserted an ampersand??

Siv
"Stephany Young" <noone@localhostwrote in message
news:OR**************@TK2MSFTNGP03.phx.gbl...
Again, by your own words, earlier you were insering an XML comment, so
saying that you didn't know it was XML just doessn't cut it.

It told you the exact reason for the warning, viz. whitespace not allowed
at that location. You had a space character directly following an &
character and that is not allowed in XML.

The use of XML comments, reasonably, expects the author to be able to
write wel-formaed XML. If you are not comfortable with XML then don't use
XML comments.
"Siv" <g@removethistextsivill.comwrote in message
news:26**********************************@microsof t.com...
>Hi,
Ok "Warning" I must be more precise. However, I think when I am entering
a comment in my code and it "warns" me that "whitespace is not allowed at
this location .." when in fact it should say "Ampersand not allowed in VB
comment" it's more like a bug in VB as it is not telling me the true
reason for the error.

Your response assumes I understand XML which I never use, and have never
really understood why everyone raves about it? It just seems a bit
insecure as a method of holding or transmitting data as it's just plain
text that can be intercepted and read as such. I get the interactivity
between systems as a common data language, but you can achieve the same
thing with a flat file??

Siv

"Stephany Young" <noone@localhostwrote in message
news:uh****************@TK2MSFTNGP03.phx.gbl...
>>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@removethistextsivill.comwrote in message
news:0C**********************************@micros oft.com...
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
Jun 27 '08 #9

P: n/a
Siv
Stephany,

That may be true, I wasn't looking for excuses, like most VB'ers who come
here we are looking for answers to problems that we can't resolve ourselves.
I didn't come here to be scolded for not understanding the internal workings
of XML. I came here to post what I thought was a bug (and still do
actually) in the VB parser. I also posted it because in finding that when I
removed the ampersand the issue went away. 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 your replies subsequently) 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.

The responses you give or rather the way that you deliver them, seem to be a
bit patronising. People should not be discouraged from asking questions here
even if to an experienced Guru like you they are child like. If all you are
about is showing off how clever you are at the expense of other users who
may not know as much as you, then you really shouldn't be here! Your
responses remind me of the Linux forums a few years back where newbies were
roasted for not knowing the internal working of BASH or some other esoteric
Unix command line switch.

Siv
"Stephany Young" <noone@localhostwrote in message
news:Oo**************@TK2MSFTNGP05.phx.gbl...
Ignorance is no excuse.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl...
>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@localhostschreef in bericht
news:eF**************@TK2MSFTNGP05.phx.gbl...
>>Yes, certainly the user made an error, but the point is that VS reported
a warning and not an error.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl...
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@localhostschreef in bericht
news:uh****************@TK2MSFTNGP03.phx.gbl. ..
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@removethistextsivill.comwrote in message
news:0C**********************************@micr osoft.com...
>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
>>
>>
>

Jun 27 '08 #10

P: n/a
The whoule point is that youre not writing a comment.

You are writing an XML comment and there is a big difference.

A comment is all the text, on a line, that follows a single '

An XML comment is a block of text where each line starts ith ''' (3) and
otherwise contains well-formed XML.

If all you want to do is have readable comments in your code then just use
comments.

If you want to produce documentation, using the built-in mechanism, or
provide intellisense then you need to use XML comments and to use them you
MUST follow the syntax rules.

It is your choice, but don't blame the product when your syntax is not
correct.
"Siv" <g@removethistextsivill.comwrote in message
news:e5**************@TK2MSFTNGP03.phx.gbl...
Stephany,
I didn't say I didn't know it was XML I said I didn't "understand" it. I
am aware that the the comments system used by VB.NET uses XML but that
doesn't mean I understand its internal working. You seem to be indicating
that I should? I am aware that my car uses an internal combustion engine
but I wouldn't dare mess with its internal workings or know everything
about how it works. I feel the same about comments. I have always used
comments as a way of letting others (or indeed myself when returning to
code I haven't worked on in a long time), know how a procedure works and
any assumptions that I have made when processing through it.

Using XML in comments was forced on me by MS when they designed the new
commenting system, and don't get me wrong, I like the fact that when I
start to type a call to the commented procedure it starts to tell me the
meanings of the parameters etc. To me this is just a bit of internal
working of VB.NET, not something I can manipulate other than by using its
advertised mechanisms. I have yet to fathom out how I turn these comments
into documentation for my project which I am sure I can do, but have so
far been totally unable to find out how??

To me there is a bug in the parser if it tells a (non XML understanding)
VB user that there is a problem with whitespace in the comment when in
fact it's a problem with you having inserted an ampersand??

Siv
"Stephany Young" <noone@localhostwrote in message
news:OR**************@TK2MSFTNGP03.phx.gbl...
>Again, by your own words, earlier you were insering an XML comment, so
saying that you didn't know it was XML just doessn't cut it.

It told you the exact reason for the warning, viz. whitespace not allowed
at that location. You had a space character directly following an &
character and that is not allowed in XML.

The use of XML comments, reasonably, expects the author to be able to
write wel-formaed XML. If you are not comfortable with XML then don't use
XML comments.
"Siv" <g@removethistextsivill.comwrote in message
news:26**********************************@microso ft.com...
>>Hi,
Ok "Warning" I must be more precise. However, I think when I am entering
a comment in my code and it "warns" me that "whitespace is not allowed
at this location .." when in fact it should say "Ampersand not allowed
in VB comment" it's more like a bug in VB as it is not telling me the
true reason for the error.

Your response assumes I understand XML which I never use, and have never
really understood why everyone raves about it? It just seems a bit
insecure as a method of holding or transmitting data as it's just plain
text that can be intercepted and read as such. I get the interactivity
between systems as a common data language, but you can achieve the same
thing with a flat file??

Siv

"Stephany Young" <noone@localhostwrote in message
news:uh****************@TK2MSFTNGP03.phx.gbl.. .
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@removethistextsivill.comwrote in message
news:0C**********************************@micro soft.com...
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
>
>

Jun 27 '08 #11

P: n/a
"Michel Posseth [MCP]" <MS**@posseth.comschrieb:
as XML follows the same rules as HTML for special characters
This is not entirely correct, but basically you are right -- certain
characters must be "escaped".

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://dotnet.mvps.org/dotnet/faqs/>

Jun 27 '08 #12

P: n/a
Siv ,,,

Don`t get upset about postings in the groups ,, some people over here are
indeed a bit rude in there answering
this may have several reassons .

1. The person asnwering is really a sociopath
http://wiki.answers.com/Q/How_do_you...is_a_sociopath

2. The person answering lives in a european country wich is competing in
the EK soccer and he / she is not wearring orange at this moment
especially Italian and French people are a bit tricky at the moment
;-)
http://en.wikipedia.org/wiki/Netherl..._football_team ( scroll
to the 2008 section below )

3. The person answering might not have his / her day ,,,,, most of the times
a look at other postings of this person at this day and other days is enough
to know if this is true .

4. Not all persons in this group ( me for instance ) are native English
speakers , so remember that sometimes the postings are interpreted in a
different way as they were intended.

If you are a bit longer active in this groups you will know them bether ,
and you will see that we are all humans here and most of the times only
option 2, 3 or 4 apply . Ocassionally we have a option 1 but i can ensure
you that those people are a long time not seen here .

regards

Michel Posseth


"Siv" <g@removethistextsivill.comschreef in bericht
news:up**************@TK2MSFTNGP06.phx.gbl...
Stephany,

That may be true, I wasn't looking for excuses, like most VB'ers who come
here we are looking for answers to problems that we can't resolve
ourselves. I didn't come here to be scolded for not understanding the
internal workings of XML. I came here to post what I thought was a bug
(and still do actually) in the VB parser. I also posted it because in
finding that when I removed the ampersand the issue went away. 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 your
replies subsequently) 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.

The responses you give or rather the way that you deliver them, seem to be
a bit patronising. People should not be discouraged from asking questions
here even if to an experienced Guru like you they are child like. If all
you are about is showing off how clever you are at the expense of other
users who may not know as much as you, then you really shouldn't be here!
Your responses remind me of the Linux forums a few years back where
newbies were roasted for not knowing the internal working of BASH or some
other esoteric Unix command line switch.

Siv
"Stephany Young" <noone@localhostwrote in message
news:Oo**************@TK2MSFTNGP05.phx.gbl...
>Ignorance is no excuse.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl...
>>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@localhostschreef in bericht
news:eF**************@TK2MSFTNGP05.phx.gbl...
Yes, certainly the user made an error, but the point is that VS
reported a warning and not an error.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl...
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@localhostschreef in bericht
news:uh****************@TK2MSFTNGP03.phx.gbl.. .
>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@removethistextsivill.comwrote in message
>news:0C**********************************@mic rosoft.com...
>>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
>>>
>>>
>>
>
>

Jun 27 '08 #13

P: n/a
Siv
Michel,

I am quite "thick skinned" so it didn't bother me too much. I know I am not
the most knowledgeable person on VB.NET as I only use the bits of the system
that work for me in getting the job done. I don't have a lot of time to get
to really know the product to the level that you guys do, even though I have
been using VB since version 1.

I am a self employed developer and keep promising myself that when I have
built up some spare funds I should get on a course that teaches me the full
working of the Visual Studio IDE and a deeper understanding of VB and the
..NET framework as I am sure I am not getting the best out of it.

I just wanted to make Stephany aware that her style of response seems very
unwelcoming and her tone unnecessarily superior. I have always found that
these newsgroups are generally a friendly and welcoming place where
developers can get help and advice from their peers without fear of being
scolded for not knowing something that an expert feels they should know. I
would love to spend months playing with Visual Studio and getting to know
every aspect of it, but I have to earn a living and that stops me from doing
that.

Thanks for taking the time to respond to this as it's nice to know that some
experts do care about those who come here looking for help.

Siv

"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2***************@TK2MSFTNGP06.phx.gbl...
Siv ,,,

Don`t get upset about postings in the groups ,, some people over here are
indeed a bit rude in there answering
this may have several reassons .

1. The person asnwering is really a sociopath
http://wiki.answers.com/Q/How_do_you...is_a_sociopath

2. The person answering lives in a european country wich is competing in
the EK soccer and he / she is not wearring orange at this moment
especially Italian and French people are a bit tricky at the moment
;-)
http://en.wikipedia.org/wiki/Netherl..._football_team (
scroll to the 2008 section below )

3. The person answering might not have his / her day ,,,,, most of the
times a look at other postings of this person at this day and other days
is enough to know if this is true .

4. Not all persons in this group ( me for instance ) are native English
speakers , so remember that sometimes the postings are interpreted in a
different way as they were intended.

If you are a bit longer active in this groups you will know them bether ,
and you will see that we are all humans here and most of the times only
option 2, 3 or 4 apply . Ocassionally we have a option 1 but i can ensure
you that those people are a long time not seen here .

regards

Michel Posseth


"Siv" <g@removethistextsivill.comschreef in bericht
news:up**************@TK2MSFTNGP06.phx.gbl...
>Stephany,

That may be true, I wasn't looking for excuses, like most VB'ers who come
here we are looking for answers to problems that we can't resolve
ourselves. I didn't come here to be scolded for not understanding the
internal workings of XML. I came here to post what I thought was a bug
(and still do actually) in the VB parser. I also posted it because in
finding that when I removed the ampersand the issue went away. 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 your
replies subsequently) 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.

The responses you give or rather the way that you deliver them, seem to
be a bit patronising. People should not be discouraged from asking
questions here even if to an experienced Guru like you they are child
like. If all you are about is showing off how clever you are at the
expense of other users who may not know as much as you, then you really
shouldn't be here! Your responses remind me of the Linux forums a few
years back where newbies were roasted for not knowing the internal
working of BASH or some other esoteric Unix command line switch.

Siv
"Stephany Young" <noone@localhostwrote in message
news:Oo**************@TK2MSFTNGP05.phx.gbl...
>>Ignorance is no excuse.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl.. .
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@localhostschreef in bericht
news:eF**************@TK2MSFTNGP05.phx.gbl...
Yes, certainly the user made an error, but the point is that VS
reported a warning and not an error.
>
>
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl.. .
>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@localhostschreef in bericht
>news:uh****************@TK2MSFTNGP03.phx.gbl. ..
>>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@removethistextsivill.comwrote in message
>>news:0C**********************************@mi crosoft.com...
>>>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
>>>>
>>>>
>>>
>>
>>
>

Jun 27 '08 #14

P: n/a
Siv
Michael,

I am quite "thick skinned" so it didn't bother me too much. I know I am not
the most knowledgeable person on VB.NET as I only use the bits of the system
that work for me in getting the job done. I don't have a lot of time to get
to really know the product to the level that you guys do, even though I have
been using VB since version 1.

I am a self employed developer and keep promising myself that when I have
built up some spare funds I should get on a course that teaches me the full
working of the Visual Studio IDE and a deeper understanding of VB and the
..NET framework as I am sure I am not getting the best out of it.

I just wanted to make Stephany aware that her style of response seems very
unwelcoming and her tone unnecessarily superior. I have always found that
these newsgroups are generally a friendly and welcoming place where
developers can get help and advice from their peers without fear of being
scolded for not knowing something that an expert feels they should know. I
would love to spend months playing with Visual Studio and getting to know
every aspect of it, but I have to earn a living and that stops me from doing
that.

Thanks for taking the time to respond to this as it's nice to know that some
experts do care about those who come here looking for help.

Siv

"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2***************@TK2MSFTNGP06.phx.gbl...
Siv ,,,

Don`t get upset about postings in the groups ,, some people over here are
indeed a bit rude in there answering
this may have several reassons .

1. The person asnwering is really a sociopath
http://wiki.answers.com/Q/How_do_you...is_a_sociopath

2. The person answering lives in a european country wich is competing in
the EK soccer and he / she is not wearring orange at this moment
especially Italian and French people are a bit tricky at the moment
;-)
http://en.wikipedia.org/wiki/Netherl..._football_team (
scroll to the 2008 section below )

3. The person answering might not have his / her day ,,,,, most of the
times a look at other postings of this person at this day and other days
is enough to know if this is true .

4. Not all persons in this group ( me for instance ) are native English
speakers , so remember that sometimes the postings are interpreted in a
different way as they were intended.

If you are a bit longer active in this groups you will know them bether ,
and you will see that we are all humans here and most of the times only
option 2, 3 or 4 apply . Ocassionally we have a option 1 but i can ensure
you that those people are a long time not seen here .

regards

Michel Posseth


"Siv" <g@removethistextsivill.comschreef in bericht
news:up**************@TK2MSFTNGP06.phx.gbl...
>Stephany,

That may be true, I wasn't looking for excuses, like most VB'ers who come
here we are looking for answers to problems that we can't resolve
ourselves. I didn't come here to be scolded for not understanding the
internal workings of XML. I came here to post what I thought was a bug
(and still do actually) in the VB parser. I also posted it because in
finding that when I removed the ampersand the issue went away. 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 your
replies subsequently) 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.

The responses you give or rather the way that you deliver them, seem to
be a bit patronising. People should not be discouraged from asking
questions here even if to an experienced Guru like you they are child
like. If all you are about is showing off how clever you are at the
expense of other users who may not know as much as you, then you really
shouldn't be here! Your responses remind me of the Linux forums a few
years back where newbies were roasted for not knowing the internal
working of BASH or some other esoteric Unix command line switch.

Siv
"Stephany Young" <noone@localhostwrote in message
news:Oo**************@TK2MSFTNGP05.phx.gbl...
>>Ignorance is no excuse.
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl.. .
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@localhostschreef in bericht
news:eF**************@TK2MSFTNGP05.phx.gbl...
Yes, certainly the user made an error, but the point is that VS
reported a warning and not an error.
>
>
"Michel Posseth [MCP]" <MS**@posseth.comwrote in message
news:u9**************@TK2MSFTNGP03.phx.gbl.. .
>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@localhostschreef in bericht
>news:uh****************@TK2MSFTNGP03.phx.gbl. ..
>>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@removethistextsivill.comwrote in message
>>news:0C**********************************@mi crosoft.com...
>>>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
>>>>
>>>>
>>>
>>
>>
>

Jun 27 '08 #15

This discussion thread is closed

Replies have been disabled for this discussion.