Отображение XML-комментариев к новой строке

В Visual Studio можно писать комментарии к XML-документам на C# и VB.NET свойства и методы. После того, как вы напишете его, вы сможете просматривать описание свойства или метода при написании его в коде, наводить курсор мыши и использовать такой инструмент, как «Sandcastle».

Однако, если вы напишете слишком много, читабельность уменьшится, поэтому обычно вы будете писать его примерно в одной строке, но в некоторых случаях вы можете захотеть отобразить его в нескольких строках.

Если вы разбиваете строку в комментарии обычным образом, вы ожидаете, что она будет отображаться с разрывом строки при отображении описания, но когда вы действительно попробуете это, она будет отображаться следующим образом.

/// <summary>
/// これは
/// 普通に
/// 改行したもの
/// <summary>
public int Amount1 { get; set; }

Результат отображения объяснений

В тексте описания нет разрывов строк, и макет выглядит так, как будто он содержит пробелы. XML по-разному влияет на обработку пробелов и разрывов строк, и Visual Studio не считает обычные разрывы строк разрывами текста.

Итак, если вы хотите разбить текст описания на строку, как это сделать, это использовать тег «para». "para" означает "пункт". Заключите единицы измерения, которые вы хотите разбить строки следующим образом, в тег para:

/// <summary>
/// <para>paraを</para>
/// <para>使って</para>
/// <para>改行したもの</para>
/// </summary>
public int Amount2 { get; set; }

Описание отображается с разрывом строки, как показано на рисунке. Если вы используете инструмент создания документа, он также будет отображаться как абзац с разрывами строк.