Как добавить элементы, заключенные в <>, в комментарии к документации

Question

Я пытаюсь написать комментарии к документации, однако у меня есть проблема.

/// <summary>
/// Inserts an element into the System.Collections.Generic.List<T> at the specified
/// index.
/// </summary>

Когда я достигаю <T> Visual Studio думает, что я пытаюсь добавить еще один тег. Как правильно добавить такие комментарии (и если бы я мог сделать так, чтобы они могли щелкнуть в сгенерированном тексте справки, это было бы дополнительным бонусом)

Answer 1

Комментарии к документации

C # представлены в формате XML, поэтому измените < и > на < и >.

Вам лучше всего использовать тег <see> для вставки гиперссылки. В теге <see> измените <T> на {T}:

/// <summary>
/// Inserts an element into the <see cref="List{T}"/> at the specified
/// index.
/// </summary>

(Обратите внимание, что атрибут cref проверяется синтаксисом компилятором, в отличие от обычного текста.)

Answer 2

Полагаю, это поможет вам: Комментарии к документации по C # XML FAQ .

Answer 3

экранирование сущностей xml.

Change <T> into &lt;T&gt;

Answer 4

Вам необходимо использовать правильные коды символов: &lt; и &gt;.

Вы хотели бы окружить весь System.Collections.Generic.List в теге <see cref="..."/>.

Мне действительно пришлось использовать вышеупомянутые теги, чтобы правильно написать этот ответ:)

Answer 5

Поскольку комментарий представляет собой xml, вы можете использовать соответствующие escape-последовательности для xml:

/// Inserts an element into the System.Collections.Generic.List<T> at the specified