Zpracování souboru XML (Visual Basic)

Kompilátor generuje řetězec ID pro jednotlivé konstrukce kódu tagovaný generovat dokumentaci.(Informace jak kód příznaku Doporučené značky XML pro komentáře k dokumentaci (Visual Basic).) Řetězec ID jednoznačně identifikuje konstruktu.Programy, které zpracování souboru XML použít k identifikaci odpovídající řetězec ID .NET Framework zboží metadata/odraz.

Soubor XML není Hierarchická reprezentace kódu; je seznam bez stromové struktury s Generovaný pro každý prvek.

Při vytváření řetězce ID, kompilátor dodržuje následující pravidla:

• Žádné prázdné místo je umístěn v řetězci.

• První část řetězce ID identifikuje druh člena je označen jeden znak následovaný dvojtečkou.Se používají následující typy členů.

Znak	Description
N	obor názvů Nelze přidat komentáře k dokumentaci k oboru názvů, ale provedete CREF odkazy, pokud je podporována.
T	type: Class, Module, Interface, Structure, Enum,Delegate
F	pole:Dim
P	Vlastnost: Property (včetně výchozí vlastnosti)
M	method: Sub, Function, Declare,Operator
E	událost:Event
!	chybový řetězec Zbytek řetězec obsahuje informace o chybě.Visual Basic Kompilátor vygeneruje chybu informace pro odkazy, které nelze vyřešit.

• Druhá část String je plně kvalifikovaný název položky, počínaje kořen oboru názvů.Název položky, nadřazeného typu (typů) a obor názvů jsou odděleny tečkami.Pokud název samotné položky obsahuje období, se nahrazují znak čísla (#).Předpokládá se, že žádná položka má znak přímo v jeho název.Například úplný název String by konstruktoru System.String.#ctor.

• Vlastnosti a metody Pokud jsou argumenty metody, seznam argumentů, které jsou uvedeny v závorkách následuje.Pokud neexistují žádné argumenty, nejsou k dispozici žádné závorky.Argumenty jsou odděleny čárkami.Kódování každý argument přímo řídí, jak je kódován v .NET Framework podpisu.

Příklad

Následující kód ukazuje, jak řetězce ID třídy a jeho členové jsou generovány.

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

Viz také

Úkoly

Jak: vytvoření dokumentace XML v jazyce Visual Basic

Referenční dokumentace

/doc