2015-08-25 4 views
2

Я пытаюсь улучшить мою документацию по коду и решил более подробно рассмотреть XML-комментарии.vb.net: Использование <see> Тэги в комментариях XML

Если я не ошибаюсь, тег <see> должен позволять создавать интерактивные ссылки или ссылки на другие части кода.

физкультура:

Public Class Form1 

    ''' <summary> 
    ''' Does something. 
    ''' </summary> 
    Private Sub aaa() 
     'do something 
    End Sub 

    ''' <summary> 
    ''' Calls <see cref="aaa"/>. 
    ''' </summary> 
    Private Sub bbb() 
     aaa() 
    End Sub 

End Class 

Это должно создать активную ссылку на «ааа» в документации «В».

xml-код компилируется просто отлично, intellisense даже помогает с выбором ссылки, но в objectbrowser он не работает! Ссылка на «aaa» - это просто мертвый текст.

У вас есть идеи по этому вопросу? Если бы это сработало, это была бы аккуратная маленькая функция.

(я работаю на VS2010Premium)

+1

Документация говорит, что эти ссылки имеют смысл только для [некоторых внешних инструментов] (https://msdn.microsoft.com/en- нас/библиотека/VStudio/cc837134% 2 =% против 100 29.aspx). Браузер объектов также не показывает '' ссылок между страницами справки встроенных типов. – GSerg

+0

@GSerg Спасибо за ваш ответ! Так грустно - мне очень понравилась эта идея. – cl10k

ответ

2

В Visual Studio 2015, то см тег будет вызывать гиперссылки на ссылочные объекты появляться в IntelliSense вида. Поддержка объектов Viewer для этих гиперссылок по-прежнему отсутствует.

Следующий пример демонстрирует функциональные возможности IntelliSense (vb.net):

''' <summary> 
''' Gets the collection of source XML files. See <see cref="imbuddy.Collections.ImeXmlFilePaths"/> 
''' </summary> 
''' <returns>See <see cref="imbuddy.Collections.ImeXmlFilePaths"/></returns> 
Public ReadOnly Property SourceXmlFiles As Collections.ImeXmlFilePaths 

 Смежные вопросы

  • Нет связанных вопросов^_^