Как добавить объекты, включенные <> к комментариям для документации
Я пытаюсь записать комментарии для документации однако, у меня есть проблема.
/// <summary>
/// Inserts an element into the System.Collections.Generic.List<T> at the specified
/// index.
/// </summary>
Когда я достигаю <T> Visual Studio думает, что я пытаюсь добавить другой тег. что является корректным способом добавить комментарии как этот (и если бы я мог бы заставить их нажать способный в сгенерированном тексте справки, который был бы дополнительной премией),
5 ответов
Комментарии документации C # представляют собой XML, поэтому измените ваши < и > на < и > .
Что вам лучше сделать, так это использовать тег для вставки гиперссылки. В теге измените на {T} :
/// <summary>
/// Inserts an element into the <see cref="List{T}"/> at the specified
/// index.
/// </summary>
(Обратите внимание, что атрибут cref синтаксис проверяется компилятором, в отличие от обычного текста.)
Думаю, это поможет вам: Комментарии к документации C # XML FAQ .
Необходимо использовать правильные коды символов: & lt ; и & gt ;.
Вы хотите заключить весь System.Collections.Generic.List .
Мне действительно пришлось использовать вышеупомянутые теги, чтобы правильно написать этот ответ:)
Поскольку комментарий - это xml, вы можете использовать соответствующие escape-последовательности для xml:
/// Inserts an element into the System.Collections.Generic.List<T> at the specified