Book a Demo

Author Topic: C# /// <remarks/> mis-parsed  (Read 2609 times)

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8626
  • Karma: +259/-129
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
C# /// <remarks/> mis-parsed
« on: October 05, 2006, 12:49:16 pm »
/// <remarks/> in the code end up as <remarks/> in the notes. (EA 6.5(798.))

They should be ignored as they denote empty remarks.  These comments are generated by various Microsoft tools.

Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: C# /// <remarks/> mis-parsed
« Reply #1 on: October 05, 2006, 01:14:36 pm »
But what happens if they have been filled in? Does the content get rendered?
No, you can't have it!

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: C# /// <remarks/> mis-parsed
« Reply #2 on: October 05, 2006, 03:02:47 pm »
The problem is that they need to be imported (even if they are empty) so that EA can generate them back out again.

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: C# /// <remarks/> mis-parsed
« Reply #3 on: October 05, 2006, 03:34:25 pm »
Which makes sense.

That said, I gather that if the user has put something in the body (on the VS side) then that will also survive the round trip.
No, you can't have it!

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8626
  • Karma: +259/-129
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Re: C# /// <remarks/> mis-parsed
« Reply #4 on: October 06, 2006, 12:09:34 am »
Quote
The problem is that they need to be imported (even if they are empty) so that EA can generate them back out again.
As David said, it makes sense, but just to make sure I understand the intended behaviour....

<summary> stuff goes into the Notes without the tags, while <remarks> stuff (now of necessity) retains its tags and thus I saw what I saw...

Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!