Przeczytaj w języku angielskim

Udostępnij za pośrednictwem


Ostrzeżenie kompilatora (poziom 1) CS1723

Komentarz XML ma atrybut cref "attribute", który odwołuje się do parametru typu

Ten błąd jest generowany dla komentarza XML w przypadku użycia tagu <see/> z odwołaniem krzyżowym (cref) do parametru typu zamiast istniejącego typu (zdefiniowanego przez użytkownika lub wbudowanego) w kodzie. Nie można połączyć się z atrybutem typów ogólnych, ponieważ w momencie tworzenia dokumentacji typ przyszły podany jako "atrybut" nie jest jeszcze znany.

Aby rozwiązać ten problem, należy użyć tagu typeparamref/>.<

Przykład

Poniższy przykład zawiera komentarz generujący CS1723 oraz odwołanie, które można połączyć poprawnie.

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>
{
}

W tym przykładzie pokazano, jak poprawnie połączyć zarówno typ T ogólny, jak i już znany zdefiniowany przez użytkownika 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>
{
}