c# - tipos - que es una clase en programacion

¿Cuál es la forma correcta de comentar un constructor en una clase genérica?

Question

¿Cuál es la forma correcta de comentar esto? VS se queja de ello:

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

La advertencia 11 comentario XML sobre ''Data.Repository.Repository (Data.IUnitOfWork)'' tiene un atributo de creación ''Repository'' que no se pudo resolver C: / Projects / xx / yy / DataAccess / Repository.cs 35 58 Data

Answer 1

Necesitas usar llaves:

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

Para cada typeparam, simplemente agregue un valor adicional entre llaves, delimitado con una coma.

Answer 2

StyleCop ha definido cómo debería ser .

Si la clase contiene parámetros genéricos, estos se pueden anotar dentro del enlace cref usando cualquiera de los dos formatos siguientes:

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