<see> tag dokumentasi
Tag <see> memungkinkan Anda menentukan link dari dalam teks. Gunakan <seealso> untuk menunjukkan teks yang mungkin ingin Anda munculkan di bagian Lihat juga .
Sintaks
/// <see cref="member"/>
Parameter
member
Referensi ke anggota atau bidang yang tersedia untuk dipanggil dari lingkungan kompilasi saat ini. Sertakan nama dalam tanda kutip tunggal atau ganda.
Pengkompilasi memeriksa bahwa elemen kode yang diberikan ada dan diselesaikan member ke nama elemen dalam XML output. Pengkompilasi mengeluarkan peringatan jika tidak menemukan member.
Keterangan
Kompilasi dengan /doc untuk memproses komentar dokumentasi ke file.
Untuk contoh penggunaan <see>, lihat <summary>.
Pengkompilasi MSVC akan mencoba menyelesaikan cref referensi dalam satu melewati komentar dokumentasi. Jika pengkompilasi tidak menemukan simbol saat menggunakan aturan pencarian C++, itu menandai referensi sebagai tidak terselesaikan. Untuk informasi selengkapnya, lihat <seealso> .
Contoh
Sampel berikut menunjukkan bagaimana Anda dapat membuat cref referensi ke jenis generik sehingga pengkompilasi akan menyelesaikan referensi.
// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};
// the following cref shows another way to specify the reference,
// such that, the compiler will resolve the reference
/// <see cref="C < T >"/>
// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};
/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};