使 XML 注释换行

更新页 :
页面创建日期 :

您可以在 Visual Studio 中的 C# 和 VB.NET 属性和方法中编写 XML 文档注释。 这样,当您编写属性或方法的代码或鼠标悬停时,可以使用 Sandcastle 等工具查看属性和方法的说明。

然而,我通常写在一行左右,因为可读性下降,如果写得太多,在某些情况下,我想显示它分为多行。

如果你在评论中通常换行,你会期望在显示描述时换行,但当你真正尝试时,你会看到以下感觉。

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

显示描述的结果

它不会在描述性文本中换行,而是在布局中,就像有空格一样。 在 XML 中,空格和换行符的处理方式不同,Visual Studio 中的普通换行符不被视为文本换行符。

因此,如果要换行说明,该怎么办?我们使用“para”标记。 “帕拉”代表“段落”。 用要换行的单位括起来,用 para 标记括起来,如下所示:

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

说明显示为换行符,如图所示。 使用文档生成工具时,它仍显示为换行符。