How to add comments to a xaml file in WPF?

Question

I used this syntax as I found online, but it throws an error:

xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" <!-- Cool comment --> xmlns:System="clr-namespace:System;assembly=mscorlib" 

'The name cannot begin with the character' <'character, the hexadecimal value is 0x3C. Line 4, position 5. 'XML is not valid.

Answer 1

I assume these XML namespace declarations are in the parent tag of your control? You cannot leave comments inside another tag. In addition, the correct syntax is correct.

 <UserControl xmlns="..."> <!-- Here a valid comment. Notice it outside the <UserControl> tag braces --> [..snip..] </UserControl> 

Answer 2

Found a nice solution from Laurent Bugnion, it might look something like this:

 <UserControl xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:d="http://schemas.microsoft.com/expression/blend/2008" xmlns:comment="Tag to add comments" mc:Ignorable="d comment" d:DesignHeight="300" d:DesignWidth="300"> <Grid> <Button Width="100" comment:Width="example comment on Width, will be ignored......"> </Button> </Grid> </UserControl> 

Here's the link: http://blog.galasoft.ch/posts/2010/02/quick-tip-commenting-out-properties-in-xaml/

Commenting on the link, added extra characters for the ignore prefix instead of highlighting:

 mc:Ignorable="ØignoreØ" 

Answer 3

You cannot embed comments in xml tags.

Bad

 <Window xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" <!-- Cool comment --> xmlns:System="clr-namespace:System;assembly=mscorlib"> 

Good

 <Window xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:System="clr-namespace:System;assembly=mscorlib"> <!-- Cool comment --> 

Answer 4

Only tip:

In Visual Studio, to comment on text, you can select the text you want to comment on, then use Ctrl + K and then Ctrl + C. To uncomment, you can use Ctrl + K and then Ctrl + U.

Answer 5

For those who study this material, comments are more important, therefore, relying on the idea of ​​Xak Tacit (from User500099 link ) for Single Property Comments, add this to the top of the XAML code block:

 <!--Comments Allowed With Markup Compatibility (mc) In XAML! xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:ØignoreØ="http://www.galasoft.ch/ignore" mc:Ignorable="ØignoreØ" Usage in property: ØignoreØ:AttributeToIgnore="Text Of AttributeToIgnore"--> 

Then in the code block

 <Application FooApp:Class="Foo.App" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:ØignoreØ="http://www.galasoft.ch/ignore" mc:Ignorable="ØignoreØ" ... AttributeNotToIgnore="TextNotToIgnore" ... ... ØignoreØ:IgnoreThisAttribute="IgnoreThatText" ... > </Application>