C#•3y ago

❔ `<code>` xml docs not showing nicely in VSCode

I want to use

<code>

<code>

<code>

<code> in my XML docs to provide examples documentation. However, extra

\

\ appears before certain characters when you actually check the documentation inside the IDE. Is there an easy fix for this?

Mayor McCheese•11/10/23, 3:41 AM

Can you try and wrap it in a cdata node?

Mayor McCheese•11/10/23, 3:43 AM

<![CDATA[stuff here]]>

ManOP•11/10/23, 4:49 PM

I will try. I have never heard of "cdata nodes" but I will look it up.

ManOP•11/10/23, 4:51 PM

If this is the correct syntax, it isn't working.

Mayor McCheese•11/10/23, 5:05 PM

it was worth a shot

Mayor McCheese•11/10/23, 5:05 PM

sorry, that was my best idea

Mayor McCheese•11/10/23, 5:06 PM

NB: cdata is basically like a way to tell xml parsers, everything between <![CDATA[<![CDATA[ and ]]>]]>

Mayor McCheese•11/10/23, 5:06 PM

so parsers break on things like &

Mayor McCheese•11/10/23, 5:06 PM

which is where you can use & instead

Mayor McCheese•11/10/23, 5:06 PM

but in a cdata section you're telling the parser, just pass through

reflectronic•11/10/23, 8:02 PM

GitHub

Official C# support for Visual Studio Code. Contribute to dotnet/vscode-csharp development by creating an account on GitHub.

reflectronic•11/10/23, 8:03 PM

it seems like a mistake

Accord•11/11/23, 8:19 PM

Was this issue resolved? If so, run

/close

/close

otherwise I will mark this as stale and this post will be archived until there is new activity.