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>
Когда я смотрю на всплывающую подсказку для этого класса в моем коде, все по-прежнему заканчивается одной строкой... WTH? Я сделал что-то не так здесь?
ОБНОВИТЬ
Хорошо, я пошел вперед и попробовал <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 ответа
Похоже, вы не понимаете, что означает "многострочный". Однострочный комментарий заканчивается в конце строки исходного кода, и если вы хотите продолжить этот комментарий, вы должны поставить "///
"на следующей строке. Многострочный комментарий начинается с"/*
"и заканчивается"*/
msgstr "так что это может заканчиваться либо одной строкой, либо несколькими строками вниз.
"Многострочный" ничего не говорит о том, как отображается текст в комментарии. Чтобы вставить разрыв строки в комментарии XML, вы должны вставить <br/>
("перерыв") или обернуть строку в <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, разрыв строки - не что иное, как пробел.