IntelliSense и свернутые XML-комментарии не отображаются должным образом в режиме просмотра - PullRequest
0 голосов
/ 16 мая 2018

Я пытаюсь создать XML-комментарии для IntelliSense и использовать для этого следующее:

'''<summary>Units
''' <para>MinOccurs: '0'</para>
''' </summary>
Public Property S_Units As String = Nothing

Свернуто это выглядит так:

'''<summary>BinLocation
Public Property B_BinLocation As String = Nothing

То, что я пытаюсь сделать, это добавить XML-комментарий, и когда он свернут, он имитирует способ отображения при детализации свойства System, такого как String.Padright свойство Microssoft ниже (я знаю, что это обычные комментарии, но требуется тот же эффект)

'
' Summary:
'     Returns a new string that left-aligns the characters in this string by padding
'     them on the right with a specified Unicode character, for a specified total length.
'
' Parameters:
'   totalWidth:
'     The number of characters in the resulting string, equal to the number of original
'     characters plus any additional padding characters.
'
'   paddingChar:
'     A Unicode padding character.
'
' Returns:
'     A new string that is equivalent to this instance, but left-aligned and padded
'     on the right with as many paddingChar characters as needed to create a length
'     of totalWidth. However, if totalWidth is less than the length of this instance,
'     the method returns a reference to the existing instance. If totalWidth is equal
'     to the length of this instance, the method returns a new string that is identical
'     to this instance.
'
' Exceptions:
'   T:System.ArgumentOutOfRangeException:
'     totalWidth is less than zero.
Public Function PadRight(totalWidth As Integer, paddingChar As Char) As [String]

Свернуто это выглядит так:

...Public Function PadRight(totalWidth As Integer) As [String]

Обратите внимание на эллипс в соответствии с объявлением функции Если я смоделирую структуру, использованную здесь, я получу следующее:

'
' Summary:
'    Summary Line
'
' Returns:
'     Returns Line
Public Property S_Units As String = Nothing

В результате свернуто:

' ...
Public Property S_Units As String = Nothing

Обратите внимание на эллипс над декларацией свойства. 1 заметным моментом является то, что я получаю образец String из пространства имен System, а на вкладке VS отображается String [from metadata]

Может ли это быть из-за того, что он показывает по-другому, или я где-то пропускаю импорт или ссылку?

Что-нибудь, что я могу попробовать?

1 Ответ

0 голосов
/ 16 мая 2018

Вы путаете специальное представление визуализатора как дополнительное представление для комментариев xml.

До VS2015 этот конкретный визуализатор не существовал для VB, и «Перейти к определению» привело бы вас к «Обозревателю объектов».Это представление управляется опцией «Текстовый редактор» «Перейти к определению».

enter image description here

Как указано в описании, это представление построено из типаметаданные и файл документации xml (если он существует в ссылочном пути).Вы можете прочитать об этих метаданных в статье: Метаданные и самоописываемые компоненты .

Нет способа включить это представление для редактора основного кода.Если бы вы скомпилировали свой код в библиотеку и сослались на него в другом решении, вы бы увидели это представление визуализатора при нажатии «Перейти к определению».

...