XML-комментарии ‹список› не отображаются в IntelliSense

Я пытаюсь заставить комментарии VB.NET XML работать с 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

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


visual-studio vb.net intellisense xml-comments visual-studio-2008
person Community    schedule 26.08.2009    source источник

Ответы (2)


arrow_upward
6
arrow_downward

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

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

person JaredPar    schedule 26.08.2009
comment
Это просто грустно.. особенно при работе со сторонними библиотеками ЭТО было бы значительным повышением производительности, поскольку одна доза не должна постоянно искать документацию. - person ntziolis; 06.09.2010
comment
своего рода возмутительно, это все еще проблема 4 года спустя. если Intellisense поддерживает новые строки (через <para>), по крайней мере, замените ими списки... - person drzaus; 19.08.2013
comment
См. также stackoverflow.com/a/1329449/880990. Кажется, вам нужно включить файл документации XML для создания файла комментариев... - person Olivier Jacot-Descombes; 11.02.2014
comment
Именно поэтому наша команда разработчиков перейдет на Rider. Грустный. На самом деле здесь многого не просят. - person crush; 20.09.2017

arrow_upward
0
arrow_downward

Вы можете «подделать» его (без чисел), окружив содержимое <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 Update 3, похоже, была добавлена ​​поддержка форматирования, поэтому вам больше не нужна внутренняя оболочка <para> или добавление собственных маркеров.

person drzaus    schedule 19.08.2013
comment
Извините, но похоже, что этот способ не поддерживается и IntelliSense. - person Son Huy TRAN; 28.10.2013
comment
@Son-HuyTRAN, так как я опубликовал это, мне больше не нужно оборачивать внутреннюю часть <para>, но это работает в VS2012 11.0.60610.01 Update 3 - какое приложение вы используете? - person drzaus; 05.11.2013
comment
Я использую VS2010 10.0.30319.1 RTMRel. Я еще не тестировал на VS2012. :-) - person Son Huy TRAN; 06.11.2013
comment
@Son-HuyTRAN: ага, это объясняет. - person drzaus; 12.11.2013
comment
Кажется, снова сломался в VS2012 11.0.61030.00 Update 4 - person Trent; 23.02.2015
comment
Могу подтвердить, что он не форматируется в VS 2015 без использования внутренней оболочки <para>. Очередное разочарование от Microsoft. - person crush; 20.09.2017