2015-05-15 15 views
9

Supponiamo che io sono un metodo come segue:Come faccio a fare riferimento ai parametri del metodo in un riepilogo del metodo quando si scrive la documentazione xml?

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

    } 

Quando pubblico la mia documentazione XML utilizzando castello di sabbia, il cref:

<see cref="personId"/> 

viene convertito in [:! PersonId].

L'avvertimento in Sandcastle è:

'destinazione del collegamento di riferimento Unknown'

Qualche consiglio? Grazie.

+3

[Per l'uso futuro, un elenco di tag XML doc] (https://msdn.microsoft.com/en-us/library/vstudio/5ast78ax%28v=vs.100 % 29.aspx) –

+1

@ Matthew-Watson, grazie, è di grande aiuto. – user2078938

risposta