<param> tag dokumentasi

Tag <param> harus digunakan dalam komentar untuk deklarasi metode guna menjelaskan salah satu parameter metode.

Sintaks

/// <param name='param-name'>description</param>

Parameter

param-name
Nama parameter metode. Sertakan nama dalam tanda kutip tunggal atau ganda. Pengkompilasi mengeluarkan peringatan jika tidak menemukan param-name.

description
Deskripsi untuk parameter.

Keterangan

Teks untuk <param> tag akan ditampilkan di IntelliSense, Browser Objek, dan di Laporan Web Komentar Kode.

Kompilasi dengan /doc untuk memproses komentar dokumentasi ke file.

Contoh

// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
   /// <param name="Int1">Used to indicate status.</param>
   void MyMethod(int Int1) {
   }
};

Lihat juga

Dokumentasi XML