XML コメントを改行して表示させるには

動作環境

Visual Studio
  • Visual Studio 2005
  • Visual Studio 2008
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013

動作確認環境

Visual Studio Visual Studio 2013

内容

Visual Studio において C# や VB.NET のプロパティやメソッドに「XML ドキュメント コメント」を書くことができます。これを記述すると、プロパティやメソッドをコードで書くときや、マウスカーソルを当てたとき、「Sandcastle」などのツールを使用したときなどに、プロパティやメソッドの説明を表示することができるようになります。

ただ、書きすぎると可読性が下がるので普通は1行ぐらいで書いてしまうのですが、場合によっては複数行に分けて表示したい場合もあるかと思います。

普通にコメント内で改行すれば、説明が表示されるときも改行して表示されることを期待すると思いますが、実際にやってみると次のような感じで表示されてしまいます。

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


説明の表示結果

説明の文章では改行されず、スペースが入ったかのようなレイアウトになります。XML では空白や改行の扱いがどう影響するかはまちまちであり、Visual Studio でも普通の改行は文章の改行とはみなさないようになっています。

では説明文を改行させたい場合どのようにすればいいかというと「para」タグを使用します。「para」は「paragraph (段落)」の略です。次のように改行させたい単位で para タグで囲みます。

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

説明文は図のように改行されて表示されます。ドキュメント生成ツールを使った場合も段落として改行されて表示されるようになります。