Menambahkan Komen ke Java Code - dummies

Penyenaraian Java ini mempunyai versi program sampel yang dipertingkatkan. Sebagai tambahan kepada semua kata kunci, pengenal, dan tanda baca, ia mempunyai teks yang dimaksudkan untuk manusia untuk dibaca.

/ * * Penyenaraian 3-6 dalam "Java For Dummies, Edisi ke-6" * * Hak Cipta 2014 Wiley Publishing, Inc. * Semua hak terpelihara. * / / ** * Kelas Displayer memaparkan teks * pada layar komputer. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. lang. System * / public display Displayer {/ ** * Kaedah utama adalah dimana * pelaksanaan kod bermula. * * @param args (Lihat Bab 11.) * / public static void main (String args []) {System. keluar. println ("Saya suka Java!"); // Saya? Anda?}}

A comment adalah bahagian khas teks dalam suatu program yang tujuannya membantu orang memahami program tersebut. Satu komen adalah sebahagian daripada dokumentasi program yang baik.

Bahasa pengaturcaraan Java mempunyai tiga jenis komen:

• Komen tradisional: Lima baris pertama senarai penyenaraian tradisional memberi komen. Komen bermula dengan / * dan berakhir dengan * /. Segala-galanya antara pembukaan / * dan tutup * / adalah untuk mata manusia sahaja. Tiada maklumat tentang "Java For Dummies, Edisi ke-6" atau Wiley Publishing, Inc. diterjemahkan oleh pengkompil.

  Garis kedua, ketiga, keempat, dan kelima dalam Penyenaraian 3-6 mempunyai tanda bintang (*) tambahan. Mereka dipanggil tambahan kerana bintang-bintang ini tidak diperlukan apabila anda membuat komen. Mereka hanya membuat komen kelihatan cantik.

• Komen akhir-line: Teks // Saya? Awak? dalam penyenaraian adalah ulasan akhir-line . Satu komen akhir-line bermula dengan dua garis miring dan pergi ke penghujung baris jenis. Sekali lagi, pengkompil tidak menerjemahkan teks di dalam komen akhir baris.

• Komentar Javadoc: komen A javadoc bermula dengan slash dan dua tanda bintang (/ **). Penyenaraian tersebut mempunyai dua komen javadoc - satu dengan teks kelas Displayer … dan yang lain dengan teks Kaedah utama adalah di mana ….

  Sebuah komen javadoc adalah jenis komen khas khas. Komentar javadoc dimaksudkan untuk dibaca oleh orang yang tidak pernah melihat kod Java. Tetapi itu tidak masuk akal. Bagaimana anda boleh melihat komen javadoc?

  Nah, satu program tertentu yang dipanggil javadoc (apa lagi?) Boleh mencari semua komen javadoc dalam penyenaraian dan mengubah komen-komen ini ke halaman web yang bagus. Angka ini menunjukkan halaman.

  

Komentar Javadoc hebat. Berikut adalah beberapa perkara hebat tentang mereka:

• Satu-satunya orang yang perlu melihat sekeping kod Java adalah pengaturcara yang menulis kod.Orang lain yang menggunakan kod tersebut boleh mengetahui kod yang dilakukan dengan melihat laman web yang dijana secara automatik.

• Oleh kerana orang lain tidak melihat kod Java, orang lain tidak membuat perubahan pada kod Java. (Dengan kata lain, orang lain tidak memasukkan ralat ke dalam kod Java yang sedia ada.)

• Oleh kerana orang lain tidak melihat kod Java, orang lain tidak perlu menguraikan kerja dalam kod Java. Semua orang ini perlu tahu tentang kod itu yang mereka baca di laman web kod itu.

• Programmer tidak membuat dua perkara berasingan - beberapa kod Java di sini dan beberapa dokumentasi mengenai kod di sana. Sebaliknya, programmer mencipta satu kod Java dan menyematkan dokumentasi (dalam bentuk komen javadoc) tepat di dalam kod.

• Yang terbaik, generasi halaman web dari komen javadoc adalah automatik. Dokumentasi semua orang mempunyai format yang sama. Tidak kira kod Java yang anda gunakan, anda mengetahui tentang kod tersebut dengan membaca halaman seperti yang ada di dalamnya. Itu bagus kerana formatnya biasa kepada sesiapa yang menggunakan Java.