XML многострочные комментарии в С# - что я делаю неправильно?
Согласно этой статье, можно получить многострочные комментарии 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?
ИЗМЕНИТЬ
gabe указал, что я неправильно понял, что означает "многострочный", и мне действительно нужно использовать <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>
Когда я смотрю на подсказку для этого класса в моем коде, все по-прежнему заканчивается на одной строке... WTH? Я сделал что-то не так здесь?
UPDATE
Хорошо, я пошел вперед и попробовал тег <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>
Ответы
Ответ 1
Похоже, вы смущены тем, что означает "многострочный". Однострочный комментарий заканчивается в конце строки исходного кода, и если вы хотите продолжить этот комментарий, вы должны поставить "///" на следующей строке. Многострочный комментарий начинается с "/*" и заканчивается символом "*/", поэтому он может заканчиваться либо на одной строке, либо на нескольких строках вниз.
Быть "многострочным" ничего не говорит о том, как отображается текст в комментарии. Чтобы поместить разрыв строки в комментарий XML, вы должны вставить <br/> ( "break" ) или обернуть строку в теге <para> ( "paragraph" ).
Ответ 2
Попробуйте это
/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
Ответ 3
Добавьте <br/> для разрывов строк или приложите абзацы в <para>...</para>. Это точно так же, как XML и HTML, разрыв строки - не что иное, как пробел.
