Memproses 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 hierarki 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 diidentifikasi, dengan satu karakter yang diikuti oleh titik dua. Jenis anggota berikut digunakan.
karakter | Deskripsi |
---|---|
N | namespace Anda tidak dapat menambahkan komentar dokumentasi ke namespace, tetapi Anda bisa membuat referensi CREF padanya, jika didukung. |
T | jenis: Class , Module , Interface , Structure , Enum , Delegate |
F | bidang: 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 link yang tidak dapat diselesaikan. |
Bagian kedua dari
String
adalah nama item yang sepenuhnya memenuhi syarat, dimulai dari akar namespace layanan. Nama item, jenis lampirannya, dan namespace dipisahkan oleh titik. Jika nama item itu sendiri memiliki titik, item digantikan oleh tanda angka (#). Diasumsikan bahwa tidak ada item yang memiliki tanda angka langsung dalam namanya. Misalnya, nama konstruktorString
yang sepenuhnya memenuhi syarat adalahSystem.String.#ctor
.Untuk properti dan metode, jika ada argumen ke metode, daftar argumen yang diapit dalam tanda kurung mengikuti. Jika tidak ada argumen, tidak ada tanda kurung. 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
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk