Комментарии XML <list>не отображаются в IntelliSense - PullRequest
11 голосов
/ 26 августа 2009

Я пытаюсь заставить XML-комментарии VB.NET работать с IntelliSense , и, возможно, это не работает так, как я думаю.

    ''' <summary>
    ''' Gets or sets the Patient Code.
    ''' <list type="bullet">
    ''' <listheader><description>Validation:</description></listheader>
    ''' <item><description>Field Required</description></item>
    ''' <item><description>Field Max Length: 25</description></item>
    ''' </list>
    ''' </summary>
    ''' <value>The region reference key.</value>

При вводе в функцию должно отображаться «Получить или установить код пациента», а затем под ним должен отображаться список маркированных элементов с «Валидацией:» в качестве заголовка?

альтернативный текст http://www.codejames.com/errored.jpg

Возможно, я делаю это неправильно, но, похоже, он работает неправильно.

Ответы [ 2 ]

5 голосов
/ 26 августа 2009

Вы делаете это неправильно, просто это не поддерживается. Хотя HTML-разметки могут появляться в выводе некоторых инструментов, IntelliSense не является одним из них.

IntelliSense - это текстовое отображение в Visual Studio 2008, и мы не поддерживаем отображение многих / большинства пометок так, как они должны отображаться в отображении в стиле HTML. Вместо этого мы стремимся вырезать теги разметки, которые не поддерживаются, и отображать полученный текст.

0 голосов
/ 19 августа 2013

Вы можете «подделать» его (без цифр), окружив содержимое <description> тегом <para> - это будет по крайней мере отображаться в Intellisense с хорошими интервалами, но без соответствующего разделителя списка (маркированный знак, номер) ).

<summary>
Gets or sets the Patient Code.
<list type="bullet">
<listheader><description>Validation:</description></listheader>
<item><description>Field Required</description></item>
<item><description>Field Max Length: 25</description></item>
</list>
</summary>
<value>The region reference key.</value>

Если вас не слишком волнует сгенерированный вывод, просто добавьте маркер в каждой строке:

<item><description><para>* Field Required</para></description></item>

См. Также <list> Документация XML

Обновление

После публикации этого обновления в VS2012 11.0.60610.01, обновление 3, добавлена ​​поддержка форматирования, поэтому вам больше не нужна внутренняя упаковка <para> или добавление собственных маркеров.

...