Bagikan melalui

Pengolahan File XML (Visual Basic)

Pengkompilasi menghasilkan string ID untuk setiap konstruksi dalam kode Anda yang ditandai untuk menghasilkan dokumentasi. (Untuk informasi tentang cara menandai kode Anda, lihat Tag Komentar XML.) String ID secara unik mengidentifikasi konstruksi. Program yang memproses file XML dapat menggunakan string ID untuk mengidentifikasi item metadata/pantulan .NET Framework yang sesuai.

File XML bukan representasi hierarkis dari kode Anda; ini adalah daftar datar dengan ID yang dihasilkan untuk setiap elemen.

Pengkompilasi mengamati aturan berikut saat menghasilkan string ID:

  • Tidak ada spasi kosong dalam string.

  • Bagian pertama dari string ID mengidentifikasi jenis anggota yang sedang diidentifikasi, dengan satu karakter diikuti oleh titik dua. Jenis anggota berikut digunakan.

Karakter Deskripsi
N ruang nama

Anda tidak dapat menambahkan komentar dokumentasi ke namespace, tetapi Anda dapat membuat referensi CREF ke namespace tersebut, jika didukung.
T type: Class, Module, Interface, Structure, Enum, Delegate
F lapangan: Dim
P properti: Property (termasuk properti default)
M metode: Sub, Function, Declare, Operator
E peristiwa: Event
! string kesalahan

String lainnya menyediakan informasi tentang kesalahan. Pengkompilasi Visual Basic menghasilkan informasi kesalahan untuk tautan yang tidak dapat diselesaikan.

  • Bagian kedua dari String adalah nama lengkap item, dimulai dari akar namespace. Nama item, jenis lampirannya, dan namespace dipisahkan oleh titik. Jika nama item itu sendiri berisi titik, item tersebut digantikan oleh tanda angka (#). Diasumsikan bahwa tidak ada item yang memiliki tanda angka langsung dalam namanya. Misalnya, nama lengkap dari konstruktor String adalah System.String.#ctor.

  • Untuk properti dan metode, jika ada argumen untuk metode, daftar argumen mengikuti dalam tanda kurung. Jika tidak ada argumen, tidak ada tanda kurung yang ada. Argumen dipisahkan oleh koma. Pengodean setiap argumen mengikuti langsung bagaimana argumen dikodekan dalam tanda tangan .NET Framework.

Contoh

Kode berikut menunjukkan bagaimana string ID untuk kelas dan anggotanya dihasilkan.

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

Lihat juga

  • Last updated on