Многострочные комментарии XML в C # - что я делаю не так?
-
23-09-2019 - |
Вопрос
Согласно эта статья, можно получать многострочные 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>
Решение
Похоже, вы не совсем понимаете, что означает "многострочный".Однострочный комментарий заканчивается в конце строки исходного кода, и если вы хотите продолжить этот комментарий, вы должны поставить "///
" на следующей строке.Многострочный комментарий начинается с "/*
" и заканчивается на "*/
" таким образом, это может заканчиваться либо на одной строке, либо на несколько строк ниже.
То, что он "многострочный", ничего не говорит о том, как отображается текст внутри комментария.Чтобы поместить разрыв строки в 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, разрыв строки - это не что иное, как пробел.