Bagikan melalui


<seealso> tag dokumentasi

Tag <seealso> memungkinkan Anda menentukan teks yang mungkin ingin Anda munculkan di bagian Lihat Juga. Gunakan <see> untuk menentukan tautan dari dalam teks.

Sintaks

/// <seealso 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.

Untuk informasi tentang cara membuat cref referensi ke jenis generik, lihat <see>.

Keterangan

Kompilasi dengan /doc untuk memproses komentar dokumentasi ke file.

Lihat <summary> contoh penggunaan <seealso>.

Pengkompilasi MSVC 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.

Contoh

Dalam sampel berikut, simbol yang belum terselesaikan direferensikan dalam cref. Komentar XML untuk ke cref A::Test dibentuk dengan baik: <seealso cref="M:A.Test" />. Namun, menjadi cref B::Test <seealso cref="!:B::Test" />.

// xml_seealso_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_seealso_tag.dll

/// Text for class A.
public ref struct A {
   /// <summary><seealso cref="A::Test"/>
   /// <seealso cref="B::Test"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void Test() {}
};

/// Text for class B.
public ref struct B {
   void Test() {}
};

Lihat juga

Dokumentasi XML