web-dev-qa-db-ja.com

ジェネリッククラスのコンストラクターをコメント化する適切な方法は何ですか?

これにコメントする適切な方法は何ですか? 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 3558データ

30
mservidio

中括弧を使用する必要があります。

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

Typeparamごとに、中括弧にコンマで区切られた値を追加するだけです。

37
AnteSim

StyleCopはそれがどのようにあるべきかを定義しました のように見える

クラスにジェネリックパラメーターが含まれている場合、これらは次の2つの形式のいずれかを使用して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()
{
}
4
Tatranskymedved