XML многострочные комментарии в C # - что я делаю не так? - PullRequest
26 голосов
/ 30 марта 2010

Согласно этой статье , можно получить многострочные комментарии 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 ]

16 голосов
/ 30 марта 2010

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

«Многострочный» ничего не говорит о том, как отображается текст в комментарии. Чтобы вставить разрыв строки в XML-комментарий, необходимо вставить <br/> («разрыв») или обернуть строку в тег <para> («абзац»).

14 голосов
/ 30 марта 2010

Попробуйте это

/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
0 голосов
/ 30 марта 2010

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

...