Skip to content

Fix formatting of CDATA sections in quick info #79627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 28, 2025
Merged

Fix formatting of CDATA sections in quick info #79627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b126f8
Fix formatting of CDATA sections in quick info
CyrusNajmabadi Jul 28, 2025
c67cd6a
Fix
CyrusNajmabadi Jul 28, 2025
5a07425
Fix
CyrusNajmabadi Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions src/EditorFeatures/CSharpTest/QuickInfo/SemanticQuickInfoSourceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8271,6 +8271,56 @@ interface IGoo { }
List<string> y = null;
"""));

[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/53384")]
public Task TestDocumentationCData2()
=> TestAsync("""
using I$$ = IGoo;
/// <summary>
/// summary for interface IGoo
/// <code><![CDATA[
/// void M()
/// {
/// Console.WriteLine();
/// }
/// ]]></code>
/// </summary>
interface IGoo { }
""",
MainDescription("interface IGoo"),
Documentation("""
summary for interface IGoo

void M()
{
Console.WriteLine();
}
"""));

[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/53384")]
public Task TestDocumentationCData3()
=> TestAsync("""
using I$$ = IGoo;
/// <summary>
/// summary for interface IGoo
/// <![CDATA[
/// void M()
/// {
/// Console.WriteLine();
/// }
/// ]]>
/// </summary>
interface IGoo { }
""",
MainDescription("interface IGoo"),
Documentation("""
summary for interface IGoo

void M()
{
Console.WriteLine();
}
"""));

[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/37503")]
public Task DoNotNormalizeWhitespaceForCode()
=> TestAsync("""
Expand Down
34 changes: 25 additions & 9 deletions ...ures/Core/Portable/DocumentationComments/AbstractDocumentationCommentFormattingService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,10 +309,20 @@ public ImmutableArray<TaggedText> Format(string rawXmlText, ISymbol symbol, Sema

private static void AppendTextFromNode(FormatterState state, XNode node, Compilation compilation)
{
if (node.NodeType is XmlNodeType.Text or XmlNodeType.CDATA)
if (node is XText textNode)
{
// cast is safe since XCData inherits XText
AppendTextFromTextNode(state, (XText)node);
if (textNode.NodeType == XmlNodeType.Text)
{
AppendTextFromTextNode(state, textNode, replaceNewLineWithPara: false);
}
else if (textNode.NodeType == XmlNodeType.CDATA)
{
state.PushStyle(TaggedTextStyle.Code | TaggedTextStyle.PreserveWhitespace);
AppendTextFromTextNode(state, textNode, replaceNewLineWithPara: true);
state.PopStyle();
}

return;
}

if (node.NodeType != XmlNodeType.Element)
Expand Down Expand Up @@ -402,8 +412,8 @@ DocumentationCommentXmlNames.SeeAlsoElementName or
state.NextListItem();
}

if (name is DocumentationCommentXmlNames.ParaElementName
or DocumentationCommentXmlNames.CodeElementName)
if (name is DocumentationCommentXmlNames.ParaElementName or
DocumentationCommentXmlNames.CodeElementName)
{
state.MarkBeginOrEndPara();
}
Expand All @@ -417,8 +427,8 @@ DocumentationCommentXmlNames.SeeAlsoElementName or
AppendTextFromNode(state, childNode, compilation);
}

if (name is DocumentationCommentXmlNames.ParaElementName
or DocumentationCommentXmlNames.CodeElementName)
if (name is DocumentationCommentXmlNames.ParaElementName or
DocumentationCommentXmlNames.CodeElementName)
{
state.MarkBeginOrEndPara();
}
Expand Down Expand Up @@ -544,13 +554,19 @@ private static string TrimCrefPrefix(string value)
return value;
}

private static void AppendTextFromTextNode(FormatterState state, XText element)
private static void AppendTextFromTextNode(FormatterState state, XText element, bool replaceNewLineWithPara)
{
var rawText = element.Value;
if ((state.Style & TaggedTextStyle.PreserveWhitespace) == TaggedTextStyle.PreserveWhitespace)
{
// Don't normalize code from middle. Only trim leading/trailing new lines.
if (replaceNewLineWithPara && rawText is ['\n', ..])
state.MarkBeginOrEndPara();

state.AppendString(rawText.Trim('\n'));

if (replaceNewLineWithPara && rawText is [.., '\n'])
state.MarkBeginOrEndPara();

return;
}

Expand Down
Loading