<example> tag dokumentasi

Tag <example> memungkinkan Anda menentukan contoh cara menggunakan metode atau anggota pustaka lainnya. Umumnya, penggunaan tag ini juga akan melibatkan <code> tag.

Sintaks

/// <example>description</example>

Parameter

description
Deskripsi sampel kode.

Keterangan

Kompilasi dengan /doc untuk memproses komentar dokumentasi ke file.

Contoh

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

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>
   /// GetZero method
   /// </summary>
   /// <example> This sample shows how to call the GetZero method.
   /// <code>
   /// int main()
   /// {
   ///    return GetZero();
   /// }
   /// </code>
   /// </example>
   static int GetZero() {
      return 0;
   }
};

Lihat juga

Dokumentasi XML