Основы VB.NET
Урок 56. XML-комментарии

Наконец-то в VB появились XML-комментарии. Раньше такие комментарии существовали только для C#. Такие комментарии позволяют создавать автоматически документацию к вашему коду.

XML-комментарии в VB начинаются с трех символов апострофа. При этом достаточно только поставить перед объявлением метода (свойства и т. д.) класса (структуры и т. п.) три символа апострофа - остальное Visual Studio поставит сама. Так, например, будет выглядеть атоматически сгенегированный XML-комментарий для метода с параметром:

    ''' <summary>
    ''' 
    ''' </summary>
    ''' <param name="a"></param>
    ''' <returns></returns>
    ''' <remarks></remarks>
    Function SomeFunction(ByVal a As Integer) As Boolean

    End Function

Вам остается только заполнить XML-комментарий соотвествующими значениями:

    ''' <summary>
    ''' SomeFunction function with parameter.
    ''' </summary>
    ''' <param name="a">Integer parameter</param>
    ''' <returns>Result</returns>
    ''' <remarks>Some note.</remarks>
    Function SomeFunction(ByVal a As Integer) As Boolean

    End Function

После этого добавленые комментарии появятся, например, в Object Browser (появляется по F2):