2015-05-15 17 views
9

Załóżmy, że mam metodę, co następuje:Jak odnieść się do parametrów metody w podsumowaniu metody podczas pisania dokumentacji 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) 
    { 

    } 

Kiedy opublikować moją dokumentację xml przy użyciu sandcastle The cref:

<see cref="personId"/> 

zostanie przekonwertowany do [!] PersonID.

Ostrzeżenie w Sandcastle jest:

'Nieznany docelowy związek odniesienia'

Wszelkie porady? Dzięki.

+3

[Do wykorzystania w przyszłości, wykaz znaczników XML doc] (https://msdn.microsoft.com/en-us/library/vstudio/5ast78ax%28v=vs.100 % 29.aspx) –

+1

@ Matthew-Watson dzięki, to świetna pomoc. – user2078938

Odpowiedz

Powiązane problemy