如何在 WPF 中的 Xaml 文件中添加注释？

Question

我使用了网上找到的语法，但它抛出了一个错误：

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

'名称不能以 '< 开头'字符，十六进制值0x3C。 第 4 行，位置 5。' XML 无效。

Answer 1

我假设这些 XAML 命名空间声明位于控件的父标记中？您不能将评论放在另一个标签内。除此之外，您使用的语法是正确的。

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

Answer 2

Laurent Bugnion 找到了一个很好的解决方案，它看起来像这样：

<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>

这是链接：
http://blog.galasoft。 ch/posts/2010/02/quick-tip-commenting-out-properties-in-xaml/

链接上的评论者为忽略前缀提供了额外的字符来代替突出显示：

mc:Ignorable=”ØignoreØ”

Answer 3

您不能在 xml 标记内插入注释。

差

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

好

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

Answer 4

提示：

在 Visual Studio 中注释文本时，您可以突出显示要注释的文本，然后使用 Ctrl + K，然后使用 Ctrl + C 。要取消注释，您可以使用 Ctrl + K，然后使用 Ctrl + U。

Answer 5

您不能将注释放入 UWP XAML 标记内。你的语法是正确的。

要做：

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

不做：

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

Answer 6

对于任何学习这些东西的人来说，评论更重要，因此借鉴 Xak Tacit 的想法
（来自 User500099 的 link) 对于单个属性注释，请将其添加到 XAML 代码块的顶部：

<!--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"-->

然后在代码块中

<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>