xsharp.eu • Minor issue with xml comments with embedded brackets
Page 1 of 1

Minor issue with xml comments with embedded brackets

Posted: Wed Aug 16, 2023 3:16 pm
by steveferrandino
Hi,

Hi,

the XML comments spec says to use ≤ and ≥ to escape < and >, respectively

so an xml comment like ≤string≥{"1","2","3","4"} should result in <string>{"1","2","3","4"}

the xml comments file throws <!--  Badly formed XML comment ignored for member ... -->

You're also supposed to be able to use cref="{string}" and the curlies get converted to brackets but that just includes the literal cref in the output

Thanks,
​​​​​​​SteveF
 

Minor issue with xml comments with embedded brackets

Posted: Wed Aug 16, 2023 3:23 pm
by robert
Steve,
the correct codes are < and >
(Less Than, Greater Than)

Robert

Minor issue with xml comments with embedded brackets

Posted: Wed Aug 16, 2023 3:28 pm
by steveferrandino
Ugh. So Sorry

Thanks!

Minor issue with xml comments with embedded brackets

Posted: Fri Aug 18, 2023 7:05 pm
by steveferrandino
still working on the xml comments and hit a snag. building an exe adds this to the xml file:
<member name="M:<Module>.$AppInit">
<summary>Compiler generated helper method.</summary>
</member>
<member name="M:<Module>.$AppExit">
<summary>Compiler generated helper method.</summary>
</member>

Sandcastle dies because of the brackets around Module

SteveF

Minor issue with xml comments with embedded brackets

Posted: Fri Aug 18, 2023 7:08 pm
by robert
Steve,
I will look into this asap

Robert

Minor issue with xml comments with embedded brackets

Posted: Fri Aug 18, 2023 7:10 pm
by steveferrandino
if i hand edit the xml to be <Module> it works