Processamento do arquivo XML (Visual Basic)

O compilador gera uma sequência de identificação para cada constructo no seu código que está marcado para gerar a documentação.(Para obter informações sobre como marcar seu código, consulte Recomendado marcas XML para comentários da documentação (Visual Basic).) A sequência de caracteres ID identifica exclusivamente o constructo.Programas que processam o arquivo XML podem usar a sequência de identificação para identificar o item metadados/reflexão.NET Framework correspondente.

O arquivo XML é não uma representação hierárquica de seu código; é uma lista simples com uma identificação gerada para cada elemento.

O compilador observa as regras a seguir quando ele gera as sequências de identificação:

• Nenhum espaço em branco é colocado na sequência de caracteres.

• A primeira parte da sequência de identificação identifica o tipo de participante que está sendo identificada, com um único caractere seguido por dois pontos.Os seguintes tipos membro são usados.

Caracterer	Descrição
N	namespace Não é possível adicionar comentários de documentação a um espaço de nomes, mas você pode fazer referências CREF a eles, onde for suportado.
T	Tipo: Class, Module, Interface, Structure, Enum, Delegate
F	campo: Dim
P	Propriedade: Property (incluindo propriedades padrão)
M	método: Sub,Function,Declare,Operator
E	evento: Event
!	sequência de caracteres de erro O restante da sequência de caracteres fornece informações sobre o erro.O compilador Visual Basic gera informações de erro para links que não podem ser resolvidos.

• A segunda parte da String é o nome totalmente qualificado do item, começando a raiz do namespace.O nome do item, seus tipos delimitador(es) e o espaço de nomes são separados por pontos.Se o próprio nome do item contiver períodos, elas serão substituídos pelo sinal de número (#).Pressupõe-se que nenhum item possui um sinal de número diretamente no seu nome.Por exemplo, o nome totalmente qualificado do construtor String seria System.String.#ctor.

• Para propriedades e métodos, se houver argumentos para o método, a lista de argumentos colocados entre parênteses segue.Se não houver nenhum argumento, nenhum parêntese estará presenteOs argumentos são separados por vírgulas.A codificação de cada argumento segue diretamente como ela é codificada em uma assinatura .NET Framework .

Exemplo

O código a seguir mostra como a identificação sequências de caracteres de uma classe e seus membros são gerados.

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

Consulte também

Tarefas

Como: criar documentação XML no Visual Basic

Referência

/doc