Мультилиния XML комментирует в C# - что я делаю неправильно?
В соответствии с этой статьей, возможно получить многострочные XML-комментарии - вместо использования ///, использовать /** */. Это - моя интерпретация того, что многострочные комментарии, и что я хочу иметь, произойдите:
/**
*
* this comment is on line 1 in the tooltip
* this comment is on line 2 in the tooltip
*
*/
Однако, когда я использую эту форму, подсказка, которая открывается, когда я нависаю над своим именем класса в моем коде, является одной строкой, т.е. выглядит точно, как будто я записал свой комментарий как это:
///
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
///
Действительно ли это поведение на самом деле возможно все еще в VS2008?
Править
gabe указал, что я неправильно понял то, что означает "мультилиния", и я на самом деле должен использовать
///
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
///
Когда я смотрю на подсказку для этого класса в моем коде, все все еще заканчивается на одной строке... WTH? Я делал что-то не так здесь?
ОБНОВЛЕНИЕ
Хорошо, я шел вперед и попробовал
///
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
///
3 ответа
Похоже, вы не понимаете, что означает "многострочный". Однострочный комментарий заканчивается в конце строки исходного кода, и если вы хотите продолжить этот комментарий, вы должны поставить « /// » на следующей строке. Многострочный комментарий начинается с « / * » и заканчивается « * / », поэтому он может заканчиваться либо на той же строке, либо на нескольких строках ниже.
"Многострочность" ничего не говорит о том, как отображается текст в комментарии. Чтобы поместить разрыв строки в комментарий XML, вы должны вставить («разрыв») или заключить строку в тег
(«абзац»).
Попробуйте это
/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
Добавьте