Skip to content

Adds a new option TreatCommentWithTagAsMultiline to control formatting of XAML comments that start with XML tags after the <!-- delimiter. #551

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

Open
Koichi-Kobayashi wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Adds a new option TreatCommentWithTagAsMultiline to control formatting of XAML comments that start with XML tags after the <!-- delimiter. #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f03a864
Add option to treat comments starting with '<' as multiline (#380)
Koichi-Kobayashi Jan 4, 2026
a07bba7
Add unit tests for TreatCommentWithTagAsMultiline option
Koichi-Kobayashi Jan 4, 2026
f68a185
Missing project file commit
Koichi-Kobayashi Jan 4, 2026
8033c69
Add a test
Koichi-Kobayashi Jan 5, 2026
f341a5d
Revert "Add a test"
Koichi-Kobayashi Jan 7, 2026
b578833
Revert "Missing project file commit"
Koichi-Kobayashi Jan 7, 2026
70584a0
Revert "Add unit tests for TreatCommentWithTagAsMultiline option"
Koichi-Kobayashi Jan 7, 2026
56aedae
Revert "Add option to treat comments starting with '<' as multiline (…
Koichi-Kobayashi Jan 7, 2026
752a86c
Reverted the previous changes and reapplied the comment formatting im…
Koichi-Kobayashi Jan 7, 2026
c559709
Add test cases
Koichi-Kobayashi Jan 7, 2026
740cd29
Patterns for Structural Organization (Making it a State Machine for R…
Koichi-Kobayashi Jan 7, 2026
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
14 changes: 14 additions & 0 deletions src/XamlStyler.UnitTests/FileHandlingIntegrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,20 @@ public void TestIgnoringNamespacesInAttributeOrderingWithoutNamespace()
FileHandlingIntegrationTests.DoTest(stylerOptions);
}

[TestCase(false)]
[TestCase(true)]
public void TestTreatCommentWithTagAsMultiline(bool treatCommentWithTagAsMultiline)
{
var stylerOptions = new StylerOptions(
config: FileHandlingIntegrationTests.GetConfiguration(@"TestConfigurations/LegacyTestSettings.json"))
{
IndentSize = 2,
TreatCommentWithTagAsMultiline = treatCommentWithTagAsMultiline,
};

this.DoTestCase(stylerOptions, treatCommentWithTagAsMultiline);
}

private static void DoTest(
StylerOptions stylerOptions,
[System.Runtime.CompilerServices.CallerMemberName] string callerMemberName = "")
Expand Down
49 changes: 49 additions & 0 deletions src/XamlStyler.UnitTests/TestFiles/TestTreatCommentWithTagAsMultiline.testxaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<Root>
<!--
<copyright>
etc etc
</copyright>
-->
<!--<copyright>
etc etc
</copyright>-->
<!-- regular comment -->
<!--
multiline comment
without tags
-->
<Window x:Class="Test.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:xctk="http://schemas.xceed.com/wpf/xaml/toolkit" xmlns:system="clr-namespace:System;assembly=mscorlib"
Title="{Binding Title}"
Height="350" Width="525" Padding="3,2 ">
<Window.Resources>
<Style TargetType="TextBox">
<Setter Property="Text" Value="Default Text &amp;&lt;" />
<Style.Triggers>
<Trigger Property="IsEnabled" Value="false">
<!--
<Setter Property="Margin" Value=" 2" />
-->
<!--<Setter Property="Padding" Value=" 2,4 " />-->
<!--<Setter Property="Padding"
Value=" 2,4 " />-->
<!--<Setter
Property="Padding"
Value=" 2,4 " />-->
</Trigger>
</Style.Triggers>
</Style>
</Window.Resources>
<DockPanel Grid.Row="0" Grid.RowSpan="1" Grid.Column="0" Grid.ColumnSpan="1" Width="Auto" Height="Auto" Margin="0,0,0,0"
HorizontalAlignment="Stretch" VerticalAlignment="Stretch">
<StackPanel>
<!--<TextBox Margin="4"></TextBox>-->
<TextBox Margin="1 2 3 4"></TextBox>
<!--<Image
Width="20" Height="20" Margin="4,0,12,0" VerticalAlignment="Center" RenderOptions.BitmapScalingMode="HighQuality"
Source="{Binding FullPath, Converter={StaticResource FileIconConverter}, Mode=OneWay}" />-->
</StackPanel>
</DockPanel>
</Window>
</Root>
60 changes: 60 additions & 0 deletions src/XamlStyler.UnitTests/TestFiles/TestTreatCommentWithTagAsMultiline_false.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<Root>
<!--
<copyright>
etc etc
</copyright>
-->
<!--<copyright>
etc etc
</copyright>-->
<!-- regular comment -->
<!--
multiline comment
without tags
-->
<Window x:Class="Test.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:system="clr-namespace:System;assembly=mscorlib"
xmlns:xctk="http://schemas.xceed.com/wpf/xaml/toolkit"
Title="{Binding Title}"
Width="525"
Height="350"
Padding="3,2 ">
<Window.Resources>
<Style TargetType="TextBox">
<Setter Property="Text" Value="Default Text &amp;&lt;" />
<Style.Triggers>
<Trigger Property="IsEnabled" Value="false">
<!--
<Setter Property="Margin" Value=" 2" />
-->
<!--<Setter Property="Padding" Value=" 2,4 " />-->
<!--<Setter Property="Padding"
Value=" 2,4 " />-->
<!--<Setter
Property="Padding"
Value=" 2,4 " />-->
</Trigger>
</Style.Triggers>
</Style>
</Window.Resources>
<DockPanel Grid.Row="0"
Grid.RowSpan="1"
Grid.Column="0"
Grid.ColumnSpan="1"
Width="Auto"
Height="Auto"
Margin="0,0,0,0"
HorizontalAlignment="Stretch"
VerticalAlignment="Stretch">
<StackPanel>
<!--<TextBox Margin="4"></TextBox>-->
<TextBox Margin="1 2 3 4" />
<!--<Image
Width="20" Height="20" Margin="4,0,12,0" VerticalAlignment="Center" RenderOptions.BitmapScalingMode="HighQuality"
Source="{Binding FullPath, Converter={StaticResource FileIconConverter}, Mode=OneWay}" />-->
</StackPanel>
</DockPanel>
</Window>
</Root>
74 changes: 74 additions & 0 deletions src/XamlStyler.UnitTests/TestFiles/TestTreatCommentWithTagAsMultiline_true.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<Root>
<!--
<copyright>
etc etc
</copyright>
-->
<!--
<copyright>
etc etc
</copyright>
-->
<!-- regular comment -->
<!--
multiline comment
without tags
-->
<Window x:Class="Test.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:system="clr-namespace:System;assembly=mscorlib"
xmlns:xctk="http://schemas.xceed.com/wpf/xaml/toolkit"
Title="{Binding Title}"
Width="525"
Height="350"
Padding="3,2 ">
<Window.Resources>
<Style TargetType="TextBox">
<Setter Property="Text" Value="Default Text &amp;&lt;" />
<Style.Triggers>
<Trigger Property="IsEnabled" Value="false">
<!--
<Setter Property="Margin" Value=" 2" />
-->
<!--
<Setter Property="Padding" Value=" 2,4 " />
-->
<!--
<Setter Property="Padding"
Value=" 2,4 " />
-->
<!--
<Setter Property="Padding"
Value=" 2,4 " />
-->
</Trigger>
</Style.Triggers>
</Style>
</Window.Resources>
<DockPanel Grid.Row="0"
Grid.RowSpan="1"
Grid.Column="0"
Grid.ColumnSpan="1"
Width="Auto"
Height="Auto"
Margin="0,0,0,0"
HorizontalAlignment="Stretch"
VerticalAlignment="Stretch">
<StackPanel>
<!--
<TextBox Margin="4"></TextBox>
-->
<TextBox Margin="1 2 3 4" />
<!--
<Image Width="20"
Height="20"
Margin="4,0,12,0"
VerticalAlignment="Center"
RenderOptions.BitmapScalingMode="HighQuality"
Source="{Binding FullPath, Converter={StaticResource FileIconConverter}, Mode=OneWay}" />
-->
</StackPanel>
</DockPanel>
</Window>
</Root>
9 changes: 9 additions & 0 deletions src/XamlStyler.UnitTests/XamlStyler.UnitTest.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,15 @@
<None Update="TestFiles\TestThicknessHandling_Space.expected">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="TestFiles\TestTreatCommentWithTagAsMultiline.testxaml">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="TestFiles\TestTreatCommentWithTagAsMultiline_false.expected">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="TestFiles\TestTreatCommentWithTagAsMultiline_true.expected">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="TestFiles\TestValueXmlEntityHandling.expected">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
Expand Down
Loading