How to reference type parameter in XML documentation?

Question

How do you reference a type parameter in XML code documentation? For instance, this code

/// <summary>
/// An interface.
/// </summary>
/// <typeparam name="TInterface">Type paramter.</typeparam>
public interface IFace<TInterface>
{
    /// <summary>
    /// Does the thing.
    /// </summary>
    /// <typeparam name="TMethod">Different from <see cref="TInterface"/>.</typeparam>
    /// <returns>An integer.</returns>
    int SomeMethod<TMethod>();
}

Gives a warning about typeparam name="TMethod":

XML comment has cref attribute 'TInterface' that refers to a type paramter.

This question asks about referencing a generic type, but I want to reference the type parameter.

BurnsBA · Accepted Answer · 2019-11-25 17:59:14Z

15

Instead of using see cref, the typeparamref should be used instead:

/// <summary>
/// An interface.
/// </summary>
/// <typeparam name="TInterface">Type paramter.</typeparam>
public interface IFace<TInterface>
{
    /// <summary>
    /// Does the thing.
    /// </summary>
    /// <typeparam name="TMethod">Different from <typeparamref name="TInterface"/>.</typeparam>
    /// <returns>An integer.</returns>
    int SomeMethod<TMethod>();
}

answered Nov 25, 2019 at 17:59

BurnsBA

5,02932 silver badges44 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to reference type parameter in XML documentation?

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related