Многострочные комментарии XML в C# - что я делаю неправильно?

по данным в этой статье, можно получить многострочные комментарии XML - вместо использования /// используйте /** */. Это моя интерпретация того, что такое многострочные комментарии, и что я хочу, чтобы произошло:

/**
 * <summary>
 * this comment is on line 1 in the tooltip
 * this comment is on line 2 in the tooltip
 * </summary>
 */

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

/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>

это поведение на самом деле возможно еще в VS2008?

редактировать

Гейб указал, что я неправильно понял, что означает" многострочный", и мне действительно нужно использовать <para> или <br> чтобы получить желаемый эффект. Я пошел вперед и использовать <br> потому что я хочу контролировать, где происходят разрывы линии, т. е.

/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>

когда я смотрю на подсказку для этого класса в моем коде, все по-прежнему заканчивается на одной строке... С? Я сделал что-то неправильно здесь?

обновление

хорошо, я пошел вперед и попробовал <para> тег в каждой строке, и это работает. Не уверен, почему <br/> нет.

/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

3 ответов


похоже, вы смущены тем, что означает" многострочный". Однострочный комментарий заканчивается в конце строки кода, и если вы хотите продолжить этот комментарий вы должны поставить "///" на следующей строке. Многострочный комментарий начинается с "/*" и заканчивается "*/ " таким образом, он может заканчиваться либо на одной строке, либо на нескольких строках вниз.

быть "многострочным" ничего не говорит о том, как отображается текст в комментарии. Поставить разрыв строки в XML комментарий необходимо вставить <br/> ("break") или оберните линию в <para> ("пункт") тега.


попробуй такое

/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

добавить <br/> для разрывов строк или заключите абзацы в <para>...</para>. Это так же, как XML и HTML, разрыв строки-это не что иное, как пробелы.