XML Documentation File Format

Where is the format of the XML documentation file specified? This is the file generated when you have selected 'Generate XML documentation' under the compile tab.

Here is a sample app and the doc file for it

Code:

---

Public Class Form1
    ''' <summary>
    ''' flags used
    ''' </summary>
    ''' <remarks>integer</remarks>
    Private flag As Integer

    ''' <summary>
    ''' button 1
    ''' </summary>
    ''' <param name="sender">a button</param>
    ''' <param name="e">event args</param>
    ''' <remarks>remarks button</remarks>
    Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

    End Sub

    ''' <summary>
    ''' method foo
    ''' </summary>
    ''' <remarks>remarks foo</remarks>
    Public Sub foo()

    End Sub

    ''' <summary>
    ''' mehtod bar
    ''' </summary>
    ''' <param name="someStr">a string</param>
    ''' <returns>true or false</returns>
    ''' <remarks>remarks bar</remarks>
    Public Function bar(someStr As String) As Boolean

    End Function
End Class

---

Code:

---

<doc>
<assembly>
<name>
WindowsApplication2
</name>
</assembly>
<members>
<member name="P:WindowsApplication2.My.Resources.Resources.ResourceManager">
        <summary>
  Returns the cached ResourceManager instance used by this class.
</summary>
</member><member name="P:WindowsApplication2.My.Resources.Resources.Culture">
        <summary>
  Overrides the current thread's CurrentUICulture property for all
  resource lookups using this strongly typed resource class.
</summary>
</member><member name="T:WindowsApplication2.My.Resources.Resources">
        <summary>
  A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member><member name="F:WindowsApplication2.Form1.flag">
        <summary>
 flags used
 </summary>
        <remarks>integer</remarks>
</member><member name="M:WindowsApplication2.Form1.Button1_Click(System.Object,System.EventArgs)">
        <summary>
 button 1
 </summary>
        <param name="sender">a button</param>
        <param name="e">event args</param>
        <remarks>remarks button</remarks>
</member><member name="M:WindowsApplication2.Form1.foo">
        <summary>
 method foo
 </summary>
        <remarks>remarks foo</remarks>
</member><member name="M:WindowsApplication2.Form1.bar(System.String)">
        <summary>
 mehtod bar
 </summary>
        <param name="someStr">a string</param>
        <returns>true or false</returns>
        <remarks>remarks bar</remarks>
</member>
</members>
</doc>

---

I believe I have found the answer
https://docs.microsoft.com/en-us/dot...g-the-xml-file

Quote:

---

Originally Posted by dbasnett

I believe I have found the answer
https://docs.microsoft.com/en-us/dot...g-the-xml-file

---

Hey, this looks useful. When I look at those tags, my own commenting style looks clumsy. Thanks.