Pemisah untuk tag dokumentasi Visual C++

Penggunaan tag dokumentasi memerlukan pemisah, yang menunjukkan kepada pengkompilasi di mana komentar dokumentasi dimulai dan berakhir.

Anda bisa menggunakan jenis pemisah berikut dengan tag dokumentasi XML:

Pemisah	Deskripsi
///	Ini adalah formulir yang ditampilkan dalam contoh dokumentasi dan digunakan oleh templat proyek Visual Studio C++.
/** */	Ini adalah pemisah multibaris.

Ada beberapa aturan pemformatan saat menggunakan pemisah /** */ :

• Untuk baris yang berisi pemisah /** , jika sisa baris adalah spasi kosong, baris tidak diproses untuk komentar. Jika karakter pertama adalah spasi kosong, karakter spasi kosong tersebut diabaikan dan sisa baris diproses. Jika tidak, seluruh teks baris setelah pemisah /** diproses sebagai bagian dari komentar.

• Untuk baris yang berisi pemisah */ , jika hanya ada spasi kosong hingga pemisah */ , garis tersebut diabaikan. Jika tidak, teks pada baris hingga pemisah */ diproses sebagai bagian dari komentar, tunduk pada aturan pencocokan pola yang dijelaskan dalam poin berikut.

• Untuk garis setelah yang dimulai dengan pemisah /** , pengkompilasi mencari pola umum di awal setiap baris yang terdiri dari spasi putih opsional dan tanda bintang (*), diikuti oleh spasi kosong yang lebih opsional. Jika pengkompilasi menemukan sekumpulan karakter umum di awal setiap baris, itu akan mengabaikan pola tersebut untuk semua baris setelah pemisah /** , hingga dan mungkin menyertakan baris yang berisi pemisah */ .

Contoh

• Satu-satunya bagian dari komentar berikut yang akan diproses adalah baris yang dimulai dengan <summary>. Dua format tag berikut akan menghasilkan komentar yang sama:

  /**
  <summary>text</summary>
  */
  /** <summary>text</summary> */
  

• Pengkompilasi menerapkan pola " * " untuk mengabaikan di awal baris kedua dan ketiga.

  /**
   * <summary>
   *  text </summary>*/
  

• Pengkompilasi tidak menemukan pola dalam komentar ini karena tidak ada tanda bintang pada baris kedua. Semua teks pada baris kedua dan ketiga, hingga */, akan diproses sebagai bagian dari komentar.

  /**
   * <summary>
     text </summary>*/
  

• Pengkompilasi tidak menemukan pola dalam komentar ini karena dua alasan. Pertama, tidak ada garis yang dimulai dengan jumlah spasi yang konsisten sebelum tanda bintang. Kedua, baris kelima dimulai dengan tab, yang tidak cocok dengan spasi. Semua teks dari baris kedua hingga */ akan diproses sebagai bagian dari komentar.

  /**
    * <summary>
    * text
   *  text2
     *  </summary>
  */
  

Baca juga

Dokumentasi XML