Membuat Dokumentasi API API - dummies

Dahulu kala, orang menilai bahasa pemrograman (termasuk Jawa) hanya berdasarkan fitur gramatikal mereka. Apakah pernyataan jika melakukan apa yang Anda harapkan? Apakah pernyataan perulangan mudah digunakan? Apakah metode diterapkan secara efisien?

Saat ini, ada sedikit perbedaan. Java memiliki keseluruhan koleksi fitur gramatikal, tapi Java lebih dari sekadar seperangkat aturan tata bahasa yang besar. Java memiliki Appl ication Programming Interface - sebuah perpustakaan besar yang terdiri dari lebih dari 4.000 kelas, masing-masing memiliki fungsinya sendiri, keterbatasannya sendiri, dan peraturannya sendiri untuk penggunaan yang efektif.

Mencari istilah

Anda dapat menemukan berbagai hal dalam dokumentasi API dengan berbagai cara. Setiap cara mudah dalam satu situasi atau lainnya. Sebagai contoh, Java memiliki metode bernama System. di luar. println Berikut ini dijelaskan dua cara untuk mencari Sistem. di luar. metode println

Menggunakan indeks

Berikut adalah cara menemukan sesuatu, seperti System. di luar. println, dengan menggunakan indeks:

1. Visit docs. peramal. com / javase / 8 / docs / api /.

2. Klik link INDEX di bagian atas halaman untuk membuka indeks, seperti yang ditunjukkan pada Gambar 1.

   

   Gambar 1: Halaman utama dokumentasi dokumentasi.

   Daftar huruf di dekat bagian atas indeks (lihat Gambar 2). Klik link P untuk menuju ke bagian dengan println di dalamnya.

   

   ">
   gambar 2: Halaman indeks dokumentasi API.

3. Di bagian P, lakukan pencarian println untuk menemukan entri println.

   Sebagian besar web browser memungkinkan Anda mencari sesuatu seperti println di teks halaman. Begini caranya:

   1. Pastikan browser mengetahui bahwa Anda ingin mencari di bingkai besar yang memakan sebagian besar halaman (dan bukan di bingkai kecil di sisi kiri halaman). Untuk melakukan ini, klik mouse Anda di dalam bingkai besar. (Jangan klik sebuah link. Klik pada beberapa area putih netral dari bingkai.)

   2. Buka kotak dialog Find's browser. Pada sebagian besar browser Windows, menekan Ctrl + F membujuk kotak dialog Find dari persembunyian. Di Mac, klik Command + F apakah triknya.

   3. Bila Anda melihat kotak dialog Find, ketik println di kotak teks dan klik tombol Find atau Find Next.

4. Pilih salah satu entri println.

   Bagian P memiliki muatan besar dari entri println, seperti yang ditunjukkan pada Gambar 3 di bawah ini. Entrinya berbeda satu sama lain dengan dua cara:

   • Setiap entri mengatakan println (int), println (String), atau println (someOtherTypeName). Nama jenis bisa berbeda dari satu entri ke entri lainnya.

   • Setiap entri mengatakan bahwa println adalah metode di kelas java. someStuff. someMoreStuff . Kelas bisa berbeda dari satu entri ke entri lainnya.

     

     println entri dalam indeks dokumentasi API. ">
     Gambar 3: Beberapa entri println dalam indeks dokumentasi API.

   Pada titik ini, perlu ditusuk. Jika Anda mencoba mencetak sesuatu seperti "Halo dunia! ", Anda menginginkan salah satu entri println (String). Di sisi lain, jika Anda mencoba mencetak nilai lengthOfStraightLine, Anda mungkin akan memilih entri println (double).

   Sekarang, anggaplah Anda telah memutuskan println (String). Anda dapat memilih dari tiga entri println (String). Salah satunya mengatakan itu adalah metode di kelas java. io. PrintStream, selanjutnya adalah metode di kelas java. io. PrintWriter, dan yang ketiga adalah metode di kelas java. sql DriverManager Manakah dari ketiga entri yang Anda pilih ini?

   Nah, yang sebenarnya ingin Anda panggil adalah sesuatu yang bernama System. di luar. println Jika Anda melewati keseluruhan talang roda dengan Systemout, Anda akan menemukan Sistem itu. out memiliki tipe PrintStream. (Lihat Gambar 4, di bawah ini.) Jadi entri println (String) yang Anda putuskan untuk dipilih adalah

   println (String) - Metode di kelas java. io. PrintStream Variabel

   

   memiliki tipe PrintStream. ">
   Gambar 4: Variabel keluar memiliki tipe PrintStream.

5. Klik link untuk entri yang telah Anda pilih.

   Bila Anda mengklik link println (String), browser membawa Anda ke halaman yang menjelaskan metode println, seperti yang ditunjukkan pada Gambar 5. Halaman tersebut memberi tahu Anda apa yang println lakukan ("Cetak String dan kemudian …") dan poin ke halaman berguna lainnya, seperti halaman dengan dokumentasi untuk String.

   

   metode println ">
   Gambar 5: Deskripsi metode println.

Menggunakan daftar kelas

Berikut adalah cara menemukan entri di API dengan memulai daftar kelas:

1. Kunjungi dokumen. peramal. com / javase / 8 / docs / api /.

2. Temukan halaman yang mendokumentasikan kelas Sistem.

   Anda mencari dokumentasi yang menjelaskan Sistem. di luar. println Jadi Anda mencari Sistem, bekerja dengan cara Anda keluar, dan dari sana, bekerja dengan cara Anda untuk mencetak.

   Untuk menemukan link ke System, cari di frame bawah di sisi kiri halaman. (Lihat Gambar 6.) Untuk petunjuk menemukan teks pada halaman, lihat Langkah 3 di bagian "Menggunakan indeks".

   

   Kelas sistem. ">
   Gambar 6: Menemukan link ke kelas System.

   Mengklik link Sistem membuat browser Anda menampilkan halaman dokumentasi untuk kelas System, seperti yang ditunjukkan pada Gambar 7.

   

   Kelas sistem dokumentasi. ">
   gambar 7: Dokumentasi kelas sistem.

3. Pada halaman dokumentasi untuk kelas Sistem, temukan variabel keluarnya.

   Jika Anda menggunakan kotak dialog Cari Web browser Anda, Anda harus mengklik tombol Find Next beberapa kali. (Nama keluar sangat umum, beberapa kali muncul dalam beberapa konteks yang berbeda di halaman dokumentasi Sistem.) Bila Anda telah menemukan apa yang Anda cari, Anda melihat tabel seperti yang ditunjukkan pada Gambar 4 di atas.

4. Di baris keluar tabel, klik link PrintStream.

   Menurut dokumentasi, variabel luar mengacu pada objek tipe PrintStream.Ini berarti println adalah bagian dari kelas PrintStream. Itu sebabnya Anda mengklik link PrintStream.

5. Pada halaman dokumentasi PrintStream, cari println (String).

   Anda melihat penjelasan seperti yang ditunjukkan pada Gambar 5 di atas.

Anda dapat melakukannya juga

Setelah mengikuti langkah-langkah dalam artikel ini, Anda mungkin tergoda untuk mengatakan, "Kesepakatan besar! Saya dapat menemukan println di dokumentasi API, tapi mungkin saya tidak dapat menemukan yang lain. Dan jika orang membuat dokumentasi untuk hal-hal yang mereka programkan sendiri, maka dokumentasi mereka tidak akan terlihat seperti dokumentasi API standar. Aku akan bangun sebuah sungai kecil. "

Tanggapan yang tepat atas keberatan tersebut adalah" Omong kosong! Omong kosong! Omong kosong! Bulu kuda "Inilah alasannya:

• Sebagian besar trik yang Anda butuhkan untuk menemukan sesuatu dalam dokumentasi Java standar diilustrasikan dalam petunjuk langkah-demi-langkah artikel ini. Jika Anda bisa menemukan System. di luar. println, Anda juga bisa menemukan javax. ayunan. JButton atau salah satu dari 4, 200 program di API Java standar.

  Dan, saat Anda mengetahui lebih banyak tentang Jawa dan hubungan antara kelas, metode, dan variabel, petunjuk langkah-demi-langkah artikel ini akan terasa jauh lebih alami.

• Seperti untuk membaca dokumentasi orang lain, Anda dapat menggaruk masalah itu langsung dari daftar Anda. Dokumen API standar tidak diketik dengan tangan. Mereka dihasilkan secara otomatis dari kode program Java yang sebenarnya. Misalnya, kode untuk PrintStream. java memiliki beberapa baris yang terlihat seperti ini:

  / ** * Cetak sebuah String dan kemudian mengakhiri barisnya. * Metode ini berperilaku seolah-olah memanggil *
  
  {@ link #print (String)}
  
  * dan kemudian
  
  {@ link #println ()}
  
  . * * @param x String
  
  
  untuk dicetak. * /
  

  Untuk membuat dokumentasi API, para kapten Java menjalankan sebuah program yang disebut javadoc . Program javadoc mengambil garis seperti ini langsung dari PrintStream. file java dan gunakan garis untuk membuat dokumentasi yang anda lihat di web browser anda.

  Pemrogram Java lainnya melakukan hal yang sama. Sebenarnya, setiap orang yang menulis kode Java menggunakan program javadoc untuk membuat dokumentasi. Jadi dokumentasi Java semua orang sepertinya dokumentasi Java orang lain. Bila Anda tahu bagaimana membaca dokumentasi API standar, Anda tahu bagaimana membaca dokumentasi Java rumahan.

  Dan ya, Anda bisa menggunakan program javadoc untuk membuat dokumentasi Anda sendiri. Saat mendownload JDK, Anda mendapatkan program javadoc sebagai bagian dari kesepakatan.