Как пометить код в C # XML документации

Question

У меня есть эта функция:

public static string Join(this IEnumerable<string> strings, string separator)
{
    return string.Join(separator, strings.ToArray());
}

, которую я хочу документировать.
Я хочу, чтобы тег <return> сказал string.Join(separator, strings.ToArray()), поскольку для любого, кто может читать код C #, это говорит больше, чемтысяча слов.Однако когда я использую

<return>string.Join(separator, strings.ToArray())</return>

, то string.Join (разделитель, strings.ToArray ()) будет отформатирован как простой текст, что делает его почти нечитаемым.Поэтому я попытался

<return><code>string.Join(separator, strings.ToArray())</code></return>

, но это всегда создает новый абзац ...

Так вот мой вопрос:
Есть ли способ отформатировать фрагмент текста, чтобы он появилсякак будто это был код?Я был бы доволен шрифтом фиксированной ширины.

Answer 1

Тег звучит так, как будто вы ищете. Проверьте MSDN тег тега для получения более подробной информации.

Тем не менее, вы уверены, что хотите, чтобы документация ссылалась непосредственно на действия, выполняемые функцией? Что если вы решите изменить реализацию позже? Я знаю, что это довольно банальный пример, но пища для размышлений! :)