How to refer to class properties in XML docs C#?

Question

Suppose I have a method in a class

public class MyClass{
   public int MyInt;

   /// <summary>
   /// Prints out the value of <paramref name="MyInt">
   /// </summary>
   public void PrintValueOfMyInt()
   {
     ...
   }
}

Is this the correct way to refer to the MyInt member in the XML doc above PrintValueOfMyInt? If not, how to do it?

Use ``: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#see — Martin Costello, Jan 17 '23 at 08:56

score 0 · Accepted Answer · answered Jan 18 '23 at 13:12

0

A solution is to use <see cref="MyInt"/>, so in total we get:

/// <summary>
/// Prints out the value of <see cref="MyInt"/>
/// </summary>
public void PrintValueOfMyInt()
{
  ...
}

answered Jan 18 '23 at 13:12

anaotha

552
6
15

How to refer to class properties in XML docs C#?

1 Answers1