<ringkasan> (Visual Basic)

Menentukan ringkasan anggota.

Sintaksis

<summary>description</summary>  

Parameter-parameternya

description
Ringkasan objek.

Komentar

<summary> Gunakan tag untuk menjelaskan jenis atau anggota jenis. Gunakan <keterangan> untuk menambahkan informasi tambahan ke deskripsi jenis.

Teks untuk <summary> tag adalah satu-satunya sumber informasi tentang jenis di IntelliSense, dan juga ditampilkan di Browser Objek. Untuk informasi tentang Browser Objek, lihat Menampilkan Struktur Kode.

Kompilasi dengan -doc untuk memproses komentar dokumentasi ke file.

Contoh

Contoh ini menggunakan <summary> tag untuk menjelaskan ResetCounter metode dan Counter properti.

''' <summary>
''' Resets the value of the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

Lihat juga

• Tag Komentar XML