Menambahkan Komentar ke Java Code - dummies

Daftar Java ini memiliki versi program contoh yang disempurnakan. Selain semua kata kunci, pengenal, dan tanda baca, ada teks yang dimaksudkan untuk dibaca manusia.

/ * * Cantumkan 3-6 di "Java For Dummies, Edisi 6" * * Copyright 2014 Wiley Publishing, Inc. * Semua hak dilindungi undang-undang. * / / ** * Kelas Displayer menampilkan teks * di layar komputer. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. lang. System * / public class Displayer {/ ** * Metode utamanya adalah dimana * eksekusi kode dimulai. * * @param args (Lihat Bab 11.) * / public static void main (String args []) {System. di luar. println ("Saya suka Jawa!"); //SAYA? Anda?}}

A komentar adalah bagian teks khusus di dalam program yang tujuannya membantu orang memahami program ini. Komentar adalah bagian dari dokumentasi program yang bagus.

Bahasa pemrograman Java memiliki tiga jenis komentar:

• Komentar tradisional: Lima baris pertama dari form daftar satu komentar tradisional . Komentar dimulai dengan / * dan diakhiri dengan * /. Segala sesuatu antara pembukaan / * dan penutupan * / hanya untuk mata manusia. Tidak ada informasi tentang "Java For Dummies, 6th Edition" atau Wiley Publishing, Inc. diterjemahkan oleh kompilator.

  Baris kedua, ketiga, keempat, dan kelima pada Listing 3-6 memiliki tanda bintang ekstra (*). Mereka disebut ekstra karena tanda bintang ini tidak diperlukan saat Anda membuat komentar. Mereka hanya membuat komentar terlihat cantik.

• Komentar akhir baris: Teks // saya? Kamu? dalam daftar adalah komentar end-of-line . Komentar end-of-line dimulai dengan dua garis miring dan sampai pada akhir garis jenis. Sekali lagi, compiler tidak menerjemahkan teks di dalam komentar end-of-line.

• Komentar Javadoc: Komentar komandan javadoc dimulai dengan garis miring dan dua tanda bintang (/ **). Daftar ini memiliki dua komentar javadoc - satu dengan teks The Displayer class … dan yang lainnya dengan teks Metode utamanya adalah di mana ….

  Komentar javadoc adalah komentar khusus jenis tradisional. Komentar javadoc dimaksudkan untuk dibaca oleh orang-orang yang bahkan tidak pernah melihat kode Java. Tapi itu tidak masuk akal. Bagaimana Anda bisa melihat komentar javadoc?

  Nah, sebuah program yang disebut javadoc (apa lagi?) Dapat menemukan semua komentar javadoc dalam daftar dan mengubah komentar ini menjadi halaman web yang bagus. Angka ini menunjukkan halaman.

  

Komentar Javadoc sangat bagus. Berikut adalah beberapa hal hebat tentang mereka:

• Satu-satunya orang yang harus melihat kode Java adalah pemrogram yang menulis kodenya.Orang lain yang menggunakan kode tersebut dapat mengetahui kode yang dilakukannya dengan melihat halaman web yang dibuat secara otomatis.

• Karena orang lain tidak melihat kode Java, orang lain tidak melakukan perubahan pada kode Java. (Dengan kata lain, orang lain tidak mengenalkan kesalahan ke kode Java yang ada.)

• Karena orang lain tidak melihat kode Java, orang lain tidak perlu menguraikan cara kerja kode Java. Semua orang ini perlu tahu tentang kodenya adalah apa yang mereka baca di halaman web kode.

• Pemrogram tidak membuat dua hal yang terpisah - beberapa kode Java di sini dan beberapa dokumentasi tentang kode di sana. Sebagai gantinya, pemrogram membuat satu bagian kode Java dan menyematkan dokumentasi (dalam bentuk komentar javadoc) tepat di dalam kode.

• Yang terbaik, generasi halaman web dari komentar javadoc bersifat otomatis. Jadi dokumentasi semua orang memiliki format yang sama. Tidak peduli kode Java mana yang Anda gunakan, Anda bisa mengetahui kode itu dengan membaca halaman seperti gambar di gambar. Itu bagus karena formatnya sudah familiar bagi siapa saja yang menggunakan Java.