Search code examples
c#.netvisual-studioxml-documentation

Can I replace the value of the <see cref=""> documentation tag?

Is it possible to change the displayed string when using the tag in c#? I'd like to do something like this:

/// <summary>
/// Do some magic on the <see cref="String">provided text</see>.
/// </summary>
public void SomeMethod(String param)
{
    // Whatever
}

So that a developer sees

Do some magic on the provided text

but will be able to be redirected to the String class when clicking on it.

Here is an image displaying my issue:

enter image description here

Solution

  • Okay so currently this is not possible, as is it not described in the documentation but this feature was supported in the past.

    I created a proposal over at the C# Language Design repository over at GitHub and a proposal for similar functionality can be found here. Hopefully this will be supported in the future!