Ссылка на универсальный тип в комментарии XML-кода
Как я знаю, в комментарии XML для типа / метода C# можно ссылаться на универсальный тип в теге следующим образом:
///<see cref="name.space.typename<T&rt;(paramtype)">
Но я думаю, что был другой синтаксис, который является менее неуклюжим? Что-то, чтобы избавиться от этих HTML-сущностей '<'? Я не могу найти это прямо сейчас. Может кто-нибудь помочь?
2 ответа
Решение
Вот хорошая статья о документации: C# 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 )" />
Используйте фигурные скобки:
///<see cref="name.space.typename{T}(paramtype)">