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

Question

对此发表评论的正确方法是什么？ VS抱怨它：

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

警告11对“Data.Repository.Repository（Data.IUnitOfWork）”的XML注释具有无法解析的cref属性“Repository”C：\ Projects \ xx \ yy \ DataAccess \ Repository.cs 35 58数据

Answer 1

你需要使用花括号：

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

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

Answer 2

StyleCop已经定义了它应该look like的方式。

  

如果类包含泛型参数，可以使用以下两种格式之一在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()
{
}