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 <see> tagu z odwołaniem krzyżowym (cref) do parametru typu zamiast istniejącego typu (zdefiniowanego przez użytkownika lub wbudowanego) w kodzie. Nie można odwołać się do 'atrybutu' typów ogólnych, ponieważ w momencie tworzenia dokumentacji przyszły typ podany jako 'atrybut' nie jest jeszcze znany.

Aby rozwiązać ten problem, użyj tagu <typeparamref> .

Example

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

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 następnym przykładzie pokazano, jak poprawnie połączyć zarówno typ ogólny T, jak i już znany typ zdefiniowany przez użytkownika Point.

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