Compiler Warning (level 4) CS1712

  • Article

Type parameter 'type parameter' has no matching typeparam tag in the XML comment on 'type' (but other type parameters do)

The documentation of a generic type is missing a typeparam tag. For more information, see <typeparam> (C# Programming Guide).

Example

The following code generates warning CS1712. To resolve this error, add a typeparam tag for the type parameter S.

// CS1712.cs
// compile with: /doc:cs1712.xml
using System;
class Test
{
    public static void Main() {}
    /// <param name="j"> This is the j parameter.</param>
    /// <typeparam name="T"> This is the T type parameter.</typeparam>
    public void bar<T,S>(int j) {}  // CS1712
}