So zeigen Sie XML-Kommentare in einer neuen Zeile an

In Visual Studio können Sie XML-Dokumentkommentare zu C#- und VB.NET-Eigenschaften und -Methoden schreiben. Sobald Sie es geschrieben haben, können Sie die Beschreibung der Eigenschaft oder Methode anzeigen, wenn Sie es in Code schreiben, den Mauszeiger bewegen und ein Tool wie "Sandcastle" verwenden.

Wenn Sie jedoch zu viel schreiben, nimmt die Lesbarkeit ab, so dass Sie es normalerweise in etwa einer Zeile schreiben, aber in einigen Fällen möchten Sie es möglicherweise in mehreren Zeilen anzeigen.

Wenn Sie eine Zeile in einem Kommentar normal umbrechen, erwarten Sie, dass sie mit einem Zeilenumbruch angezeigt wird, wenn die Beschreibung angezeigt wird, aber wenn Sie es tatsächlich versuchen, wird sie wie folgt angezeigt.

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

Ergebnis der Erläuterungsanzeige

Der Beschreibungstext enthält keine Zeilenumbrüche, und das Layout sieht aus, als ob es Leerzeichen enthält. XML hat unterschiedliche Auswirkungen darauf, wie Leerzeichen und Zeilenumbrüche behandelt werden, und Visual Studio betrachtet normale Zeilenumbrüche nicht als Textumbrüche.

Wenn Sie also den Beschreibungstext in einer Zeile unterbrechen möchten, verwenden Sie das Tag "para". "para" steht für "Absatz". Schließen Sie die Einheiten, die Sie Zeilen wie diese unterbrechen möchten, in ein para-Tag ein:

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

Die Beschreibung wird mit einem Zeilenumbruch angezeigt, wie in der Abbildung gezeigt. Wenn Sie das Dokumentgenerierungswerkzeug verwenden, wird es auch als Absatz mit Zeilenumbrüchen angezeigt.