Wie referenziere ich Methodenparameter in einer Methodenzusammenfassung beim Schreiben von XML-Dokumentation?

Question

Angenommen, ich habe eine Methode wie folgt:

/// <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) 
    { 

    } 

Wenn ich meine XML-Dokumentation mit Sandburg veröffentlichen, die cref:

<see cref="personId"/> 

zu umgewandelt wird [: PersonId].

Die Warnung in Sandcastle ist:

'Unknown Referenzlinkziel'

Jede Beratung? Danke.

Answer 1

Verwenden <paramref>

<paramref name="personId"/>