Quelle est la bonne manière de commenter un constructeur dans une classe générique?

Quelle est la bonne manière de commenter cela? VS se plaint à ce sujet:

///<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;
}

Avertissement 11 XML commentaire sur " des Données.Référentiel.Référentiel(Les Données.IUnitOfWork)' a cref attribut "Référentiel" qui n'a pas pu être résolu C:\Projects\xx\yy\DataAccess\Repository.cs 35 58 Données

  • Je ne vois pas de génériques? Ou voulez-vous dire de votre Repository classe générique?
  • Oh oups, oui. classe générique...
  • J'ai mis à jour le titre de cette question pour la rendre plus claire.
InformationsquelleAutor mservidio | 2011-07-29
  1. 37

    Vous avez besoin pour utiliser des accolades:

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

    Pour chaque typeparam, il suffit d'ajouter une valeur supplémentaire dans les accolades, délimité par une virgule.

    • Vous pouvez également utiliser les chevrons comme des entités XML &lt;T&gt;. Bien sûr, les accolades sont beaucoup plus pratique 🙂
    • BTW, "Initialise une nouvelle instance de la classe Dépôt." (sans <voir> tag) sera également OK pour StyleCop.
    • Aussi, si vous disposez de plusieurs types génériques, vous pouvez faire quelque chose comme ceci: <see cref="KeyedCollection{TKey,TItem}"/>
    InformationsquelleAutor AnteSim
  2. 4

    StyleCop a défini la façon dont il devrait ressembler.

    Si la classe contient les paramètres génériques, ceux-ci peuvent être annotées au sein du cref lien à l'aide de l'une des deux formats suivants:

    ///<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 Tatranskymedved