在泛型类中注释构造函数的正确方法是什么？

Question

对此发表评论的正确方式是什么？

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

VS对此抱怨道：

警告 11 XML 注释 'Data.Repository.Repository(Data.IUnitOfWork)' 具有 cref 属性 不可能的“存储库” 已解决 C:\Projects\xx\yy\DataAccess\Repository.cs 35 58 Data

Answer 1

您需要使用大括号：

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

对于每个 typeparam，只需在大括号中添加一个附加值，并用逗号分隔。

Answer 2

StyleCop 定义了它的外观。

如果类包含通用参数，则可以使用以下两种格式之一在 cref 链接中对这些参数进行注释：

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