Показване на XML коментари на нов ред

Страницата се актуализира :
Дата на създаване на страница :

В Visual Studio можете да напишете XML коментари за документи на C# и VB.NET свойства и методи. След като го напишете, ще можете да видите описанието на свойството или метода, когато го напишете в код, задръжте курсора на мишката и използвайте инструмент като "Sandcastle".

Ако обаче напишете твърде много, четливостта ще намалее, така че обикновено ще я напишете в около един ред, но в някои случаи може да искате да я покажете на няколко реда.

Ако прекъснете ред в коментар нормално, ще очаквате да бъде показан с прекъсване на реда, когато се покаже описанието, но когато всъщност го опитате, ще се покаже по следния начин.

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

Резултат от показване на обяснението

Няма прекъсвания на редове в текста на описанието и оформлението изглежда така, сякаш съдържа интервали. XML има различен ефект върху начина, по който се обработват прекъсванията на бялата област и линиите, а Visual Studio не счита нормалните прекъсвания на линиите за текстови прекъсвания.

Така че, ако искате да прекъснете текста на описанието на ред, как да го направите е да използвате маркера "para". "ал" означава "параграф". Оградете единиците, които искате да прекъснете линии като този, в маркер на пара:

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

Описанието се показва с прекъсване на линията, както е показано на фигурата. Ако използвате инструмента за генериране на документи, той ще се появи и като абзац с прекъсвания на редове.