How do I reference method parameters in a method summary when writing XML documentation?

Question

Suppose I have a method as follows:

    /// <summary>
    /// Here I want to reference the parameter <see cref="personId"/>.
    /// </summary>
    /// <param name="personId">
    /// The person id.
    /// </param>
    /// <returns>
    /// The <see cref="Person"/>.
    /// </returns>
    public Person GetPerson(int personId)
    {
        
    }

When I publish my XML documentation using Sandcastle, the cref:

<see cref="personId"/>

gets converted to [!:personId].

The warning in Sandcastle is:

Unknown reference link target

Any advice?

[For future use, a list of XML doc tags](https://msdn.microsoft.com/en-us/library/vstudio/5ast78ax%28v=vs.100%29.aspx) — Matthew Watson, May 15 '15 at 08:44

score 41 · Accepted Answer · edited Nov 09 '20 at 04:19

41

Use <paramref>

<paramref name="personId"/>

edited Nov 09 '20 at 04:19

Pang

9,564
146
81
122

answered May 15 '15 at 08:41

dcastro

66,540
21
145
155

How do I reference method parameters in a method summary when writing XML documentation?

1 Answers1