How to add xaml code to c # comment?

Question

/// <summary> /// /// </summary> /// <remarks /// /// </remarks> 

How to add xaml code to the above comment, avoiding the code parser to create links that do not exist (CTRL + Click messages)?

Answer 1

You have two options:

• XML standard deletion

  /// <TextBlock Text="Hello World!"/>

• CDATA sections

  /// <![CDATA[<TextBlock Text="Hello World!"/>]]>

With the first parameter, Visual Studio Intellisense will correctly display the raw XML sequence.

Answer 2

In the XAML view, put some XAML that you want to use as a comment

Then surround him

 <!-- #region XAML Snippet --> <StackPanel> <Button Content="Click me, I do nothing!" /> </StackPanel> <!-- #endregion --> 

Note. I put this in the MainWindow.xaml file, but it can be any XAML file.

Now in C # use this as a comment:

 /// <summary> /// Interaction logic for MainWindow.xaml /// </summary> /// <example> /// <code source="MyProject.Namespace/MainWindow.xaml" region="XAML snippet" lang="XAML" title="A linked *.xaml file treated as XAML"/> /// </example> 

SandCastle understands this syntax and generates the appropriate documentation (for example, on MSDN), however it will not appear in intellisense.

You can format a regular <summary> body with > and < instead of < > characters to mimic the XAML syntax, but it will be a pain.

Answer 3

Use CDATA tags?

 /// <summary> /// <![CDATA[<StackPanel />]]> /// </summary> 

Note. This will not appear in Intellisense, so if this is a requirement, this method will not work for your scenario.

Why do you want to add XAML to the code file?