英語で読む

次の方法で共有


コンパイラの警告 (レベル 1) CS1723

XML コメントに、型パラメーターを参照する cref 属性 'attribute' があります

このエラーは、コード内の既存の型 (ユーザー定義か組み込みかは問わない) ではなく、型パラメーターへのクロス参照 (cref) で <see/> タグを使用する場合に、XML コメントに対して生成されます。 ジェネリック型の 'attribute' にリンクすることはできません。ドキュメントを作成する時点で、'attribute' として指定された将来の型はまだ不明であるためです。

この問題を解決するには、<typeparamref/> タグを使用する必要があります。

次の例には、CS1723 を生成するコメントと、正しくリンクできる参照が含まれています。

C#
public class Point
{
}

// compile with: /t:library /doc:filename.XML
///<summary>A generic list class.</summary>
///uses <see cref="T" />      // CS1723
///and <see cref="Point" />   // No warning
public class List<T, Point>
{
}

この例では、ジェネリック型 T と既知のユーザー定義 Point の両方を正しくリンクする方法を示します

C#
public class Point
{
}

// compile with: /t:library /doc:filename.XML
///<summary>A generic list class.</summary>
///uses <typeparamref name="T" />  // No warning
///and <see cref="Point" />        // No warning
public class List<T, Point>
{
}