Share via

Het XML-bestand verwerken (Visual Basic)

  • Artikel

De compiler genereert een id-tekenreeks voor elke constructie in uw code die is getagd om documentatie te genereren. (Zie voor meer informatie over het taggen van uw code XML-opmerkingstags.) De id-tekenreeks identificeert de constructie op unieke wijze. Programma's die het XML-bestand verwerken, kunnen de id-tekenreeks gebruiken om het bijbehorende metagegevens-/weerspiegelingsitem van .NET Framework te identificeren.

Het XML-bestand is geen hiërarchische weergave van uw code; het is een platte lijst met een gegenereerde id voor elk element.

De compiler ziet de volgende regels wanneer de id-tekenreeksen worden gegenereerd:

  • Er wordt geen witruimte in de tekenreeks geplaatst.

  • Het eerste deel van de id-tekenreeks identificeert het type lid dat wordt geïdentificeerd, met één teken gevolgd door een dubbele punt. De volgende lidtypen worden gebruikt.

Teken Beschrijving
N naamruimte

U kunt geen documentatieopmerkingen toevoegen aan een naamruimte, maar u kunt CREF-verwijzingen naar deze maken, waar ondersteund.
T type: Class, Module, Interface, , EnumStructureDelegate
F Veld: Dim
P eigenschap: Property (inclusief standaardeigenschappen)
M methode: Sub, Function, , DeclareOperator
E Gebeurtenis: Event
! fouttekenreeks

De rest van de tekenreeks bevat informatie over de fout. De Visual Basic-compiler genereert foutinformatie voor koppelingen die niet kunnen worden opgelost.

  • Het tweede deel van het String item is de volledig gekwalificeerde naam van het item, te beginnen bij de hoofdmap van de naamruimte. De naam van het item, het bijbehorende type(en) en de naamruimte worden gescheiden door puntjes. Als de naam van het item zelf punten bevat, worden deze vervangen door het nummerteken (#). Er wordt van uitgegaan dat geen enkel item rechtstreeks een nummerteken in de naam heeft. De volledig gekwalificeerde naam van de String constructor zou bijvoorbeeld zijn System.String.#ctor.

  • Als er argumenten voor de methode zijn voor eigenschappen en methoden, volgt de lijst met argumenten tussen haakjes. Als er geen argumenten zijn, zijn er geen haakjes aanwezig. De argumenten worden gescheiden door komma's. De codering van elk argument volgt rechtstreeks hoe het wordt gecodeerd in een .NET Framework-handtekening.

Opmerking

De volgende code laat zien hoe de id-tekenreeksen voor een klasse en de bijbehorende leden worden gegenereerd.

Namespace SampleNamespace

  ''' <summary>Signature is
  ''' "T:SampleNamespace.SampleClass"
  ''' </summary>
  Public Class SampleClass

    ''' <summary>Signature is
    ''' "M:SampleNamespace.SampleClass.#ctor"
    ''' </summary>
    Public Sub New()
    End Sub

    ''' <summary>Signature is
    ''' "M:SampleNamespace.SampleClass.#ctor(System.Int32)"
    ''' </summary>
    Public Sub New(ByVal i As Integer)
    End Sub

    ''' <summary>Signature is
    ''' "F:SampleNamespace.SampleClass.SampleField"
    ''' </summary>
    Public SampleField As String

    ''' <summary>Signature is
    ''' "F:SampleNamespace.SampleClass.SampleConstant"
    ''' </summary>
    Public Const SampleConstant As Integer = 42

    ''' <summary>Signature is
    ''' "M:SampleNamespace.SampleClass.SampleFunction"
    ''' </summary>
    Public Function SampleFunction() As Integer
    End Function

    ''' <summary>Signature is
    ''' "M:SampleNamespace.SampleClass.
    ''' SampleFunction(System.Int16[],System.Int32[0:,0:])"
    ''' </summary>
    Public Function SampleFunction(
        ByVal array1D() As Short,
        ByVal array2D(,) As Integer) As Integer
    End Function

    ''' <summary>Signature is
    ''' "M:SampleNamespace.SampleClass.
    ''' op_Addition(SampleNamespace.SampleClass,
    '''             SampleNamespace.SampleClass)"
    ''' </summary>
    Public Shared Operator +(
        ByVal operand1 As SampleClass,
        ByVal operand2 As SampleClass) As SampleClass

      Return Nothing
    End Operator

    ''' <summary>Signature is
    ''' "P:SampleNamespace.SampleClass.SampleProperty"
    ''' </summary>
    Public Property SampleProperty() As Integer
      Get
      End Get
      Set(ByVal value As Integer)
      End Set
    End Property

    ''' <summary>Signature is
    ''' "P:SampleNamespace.SampleClass.Item(System.String)"
    ''' </summary>
    Default Public ReadOnly Property Item(
        ByVal s As String) As Integer

      Get
      End Get
    End Property

    ''' <summary>Signature is
    ''' "T:SampleNamespace.SampleClass.NestedClass"
    ''' </summary>
    Public Class NestedClass
    End Class

    ''' <summary>Signature is
    ''' "E:SampleNamespace.SampleClass.SampleEvent(System.Int32)"
    ''' </summary>
    Public Event SampleEvent As SampleDelegate

    ''' <summary>Signature is
    ''' "T:SampleNamespace.SampleClass.SampleDelegate"
    ''' </summary>
    Public Delegate Sub SampleDelegate(ByVal i As Integer)
  End Class
End Namespace

Zie ook