Wie kann man einen Konstruktor in einer generischen Klasse richtig kommentieren?

Was ist die richtige Art und Weise zu kommentieren? VS beschwert sich:

///<summary>
///Initializes a new instance of the <see cref="Repository"/> class.
///</summary>
///<param name="unitOfWork">The unit of work.</param>
public Repository(IUnitOfWork unitOfWork)
{
    this.UnitOfWork = unitOfWork;
}

Warnung 11 XML-Kommentar auf 'Daten.Repository.Repository(Daten.IUnitOfWork)' hat cref-Attribut 'Repository' konnte nicht aufgelöst werden C:\Projects\xx\yy\DataAccess\Repository.cs 35 58 Daten

Kommentar zu dem Problem - Öffnen
Ich sehe keine Generika? Oder meinst du Repository - Klasse generisch ist? Kommentarautor: BoltClock♦
Oh Hoppla, ja. Klasse ist generisch... Kommentarautor: mservidio
Ich habe aktualisiert, der Titel dieser Frage deutlicher machen. Kommentarautor: mservidio

InformationsquelleAutor der Frage mservidio | 2011-07-29

  1. 30

    Sie müssen geschweifte Klammern benutzen:

    ///<summary>
///Initializes a new instance of the <see cref="Repository{T}"/> class.
///</summary>

    Für jeden typeparam, fügen Sie einfach einen zusätzlichen Wert in den geschweiften Klammern, getrennt mit einem Komma.

    InformationsquelleAutor der Antwort AnteSim

  2. 0

    StyleCop definiert hat, wie es sollte Aussehen.

    Wenn die Klasse enthält generische Parameter, diese können kommentiert werden innerhalb der cref-link mit einer der beiden folgenden Formate:

    ///<summary>
///Initializes a new instance of the <see cref="Customer`1"/> class.
///</summary>
public Customer()
{
}

///<summary>
///Initializes a new instance of the <see cref="Customer{T}"/> class.
///</summary>
public Customer()
{
}

    InformationsquelleAutor der Antwort Tatranskymedved

Schreibe einen Kommentar