Как мне сделать строку документации в VB.NET? - PullRequest
2 голосов
/ 21 мая 2010

Я пишу .dll в Visual Basic. При написании кода в Visual Studio, если я делаю что-то вроде

Console.WriteLine(

появится всплывающая подсказка с небольшим количеством документации для функции. Можно ли написать что-то в моей функции / подпрограмме, которая предоставит эту информацию в Visual Studio?

Спасибо

1 Ответ

7 голосов
/ 21 мая 2010

Да, конечно! Что-то вроде:

''' <summary>
''' Comment for method
''' </summary>
''' <param name="Parameter">Comment for the parameter "Parameter"</param>
''' <remarks></remarks>
Sub Test(ByVal Parameter As Integer)

End Sub

Блок документа XML должен содержать три комментария (одинарные кавычки).

Список общих тегов XML документации можно найти здесь .

Бонус заключается в том, что компилятор может извлечь XML-файл и поместить его вместе с вашей сборкой, который инструменты генератора документации (такие как Sandcastle, NDoc) могут использовать для автоматического создания отформатированных файлов справки с документацией API.

...