Isi kandungan:

Bagaimanakah saya menambah komen pada XML dalam Visual Studio?
Bagaimanakah saya menambah komen pada XML dalam Visual Studio?

Video: Bagaimanakah saya menambah komen pada XML dalam Visual Studio?

Video: Bagaimanakah saya menambah komen pada XML dalam Visual Studio?
Video: Bagaimana MASTERPIECES dibuat! Dimash dan Sundet 2024, November
Anonim

Untuk memasukkan ulasan XML untuk elemen kod

  1. Taip /// dalam C#, atau ''' dalam Visual Basic .
  2. Daripada menu Edit, pilih IntelliSense > Sisipkan Ulasan .
  3. Daripada klik kanan atau menu konteks pada atau tepat di atas elemen kod, pilih Coretan > Sisipkan Ulasan .

Selain itu, bagaimana saya menulis komen dalam XML?

Jika anda mahu komen keluar satu baris dalam XML kod, masukkan kursor anda pada permulaan baris yang anda mahu komen keluar. Taip simbol kurang daripada diikuti dengan tanda seru dan dua sempang. Gerakkan kursor anda ke hujung baris dan kemudian taip dua sempang diikuti dengan simbol yang lebih besar daripada.

Seseorang juga mungkin bertanya, bagaimana saya mengulas kod dalam C#? Kepada kod a komen , taip garis miring ke hadapan berganda diikuti dengan komen . Anda boleh menggunakan teknik ini untuk menambah a komen pada barisnya sendiri atau untuk menambah a komen selepas kod pada satu barisan. Selalunya apabila anda kod , anda mungkin mahu komen daripada keseluruhan blok kod kenyataan.

Kedua, apakah komen XML dalam C#?

Salah satunya ialah XML Dokumentasi komen , kadangkala dipanggil Komen XML , yang bermula dengan garis miring tiga kali ganda - ///. Komen XML boleh digunakan oleh ciri IntelliSense Visual Studio dan Kod VS untuk menunjukkan maklumat tentang jenis atau ahli; maklumat ini datang daripada apa yang anda masukkan dalam dokumentasi kod anda.

Bagaimana anda mendokumentasikan kod?

Amalan terbaik untuk menulis dokumentasi:

  1. Sertakan fail README yang mengandungi.
  2. Benarkan penjejak isu untuk orang lain.
  3. Tulis dokumentasi API.
  4. Dokumenkan kod anda.
  5. Gunakan konvensyen pengekodan, seperti organisasi fail, ulasan, konvensyen penamaan, amalan pengaturcaraan, dsb.
  6. Sertakan maklumat untuk penyumbang.

Disyorkan: