Ссылка на общий тип в комментарии к коду XML

Как я знаю, в комментарии XML для типа или метода С# можно ссылаться на общий тип в теге, например:

///<see cref="name.space.typename&lt;T&rt;(paramtype)">

Но я думаю, был еще один синтаксис, который был менее неуклюжим? Что-то, чтобы избавиться от этих html-сущностей '<'? Я не могу найти его прямо сейчас. Может ли кто-нибудь помочь?

Ответы

Ответ 1

Вот хорошая статья по документации: С# XML документация комментарии FAQ

Команда разработчиков решила улучшить это, позволив альтернативному синтаксису ссылаться на общие типы и методы в комментариях к документу. В частности, вместо использования открытых и закрытых угловых скобок допустимо использовать открытые и закрытые фигурные скобки. Приведенный выше пример станет:

class Program
{
    /// <summary>
    /// DoSomething takes a <see cref="List{T}"/>
    /// </summary>
    void DoSomething(List<int> al) { }
}

Итак, в вашем случае:

///<see cref="name.space.typename{T}( paramtype )" />

Редактировать: ссылка выше является неработоспособной; показывает сырой HTML. Оставляя ссылку сейчас. Вот несколько новых ссылок от Microsoft:

Ответ 2

Используйте фигурные скобки:

///<see cref="name.space.typename{T}(paramtype)">