apa itu javadoc dan dimana downloadnya?


banyak yang baru belajar java bingung kalo disuruh liat javadoc. mereka sering nanya javadoc tuh apa? dimana dapetnya? well, sekarang gw mo bahas sedikit tentang apa itu javadoc.

javadoc itu merupakan dokumentasi dari class-class java, dokumentasi nya berisikan seluruh class, interface, dan metode-metode yang terdapat di dalamnya, bahkan kalau pembuat javadocnya rajin, biasanya dia juga mendokumentasikan cara penggunaan tiap classnya itu

biasanya javadoc itu dibuat untuk mempermudah penggunaan class bagi pihak lain yang mau menggunakan atau juga sebagai dokumentasi pribadi kalo-kalo kita lupa fungsi dari class-class yang telah kita buat. nah sekarang pertanyaannya dimana letak javadoc?

biasanya javadoc itu berada sebelum deklarasi class, metode atau property, misal :

/**
 *  BACA DENGAN TELITI !!!
 *
 *  Anda boleh menggunakan, mengubah, menghapus, menambah, dan
 *  melakukan hal yang anda inginkan ke dalam source code ini.
 *
 *  Dan saya tidak bertanggung jawab atas kesalahan,
 *  bug, atau keanehan yang ada dalam source code ini, dan
 *  saya juga TIDAK MENERIMA PERTANYAAN dari Anda
 *  mengenai isi source code ini.
 *
 *  Semoga source code ini bermanfaat bagi Anda, dan juga
 *  bermanfaat bagi project yang sedang Anda buat.
 *
 *  Salam saya, Eko Kurniawan Khannedy
 *  
 *  Dibuat Tanggal : 2009 Feb 4
 */
package echo.gokil.my.bean;

import java.io.Serializable;

/**
 * Alamat merupakan representasi dari Alamat orang class ini digunakan oleh
 * class Orang sebagai Alamat tempat tinggal orang yang bersangkutan
 * 
 * @author echo
 */
public class Alamat implements Serializable {

	/**
	 * jalan alamat
	 */
	private String jalan;
	/**
	 * kodepos alamat
	 */
	private String kodePos;
	/**
	 * kota alamat
	 */
	private String kota;
	/**
	 * negara alamat
	 */
	private String negara;

	/**
	 * membaut Alamat baru tanpa parameter
	 */
	public Alamat() {
		// TODO Auto-generated constructor stub
	}

	/**
	 * mendapatkan jalan alamat
	 * @return jalan
	 */
	public String getJalan() {
		return jalan;
	}

	/**
	 * mengubah nilai jalan alamat
	 * @param jalan
	 *             jalan yang baru
	 */
	public void setJalan(String jalan) {
		this.jalan = jalan;
	}

	/**
	 * mendapatkan kodepos alamat
	 * @return kodePos
	 */
	public String getKodePos() {
		return kodePos;
	}

	/**
	 * mengubah nilai kodepos alamat
	 * @param kodePos
	 *             kodepos yang baru
	 */
	public void setKodePos(String kodePos) {
		this.kodePos = kodePos;
	}

	/**
	 * mendapatkan kota alamat
	 * @return the kota
	 */
	public String getKota() {
		return kota;
	}

	/**
	 * mengubah nilai kota alamat
	 * @param kota
	 *             kota yang baru
	 */
	public void setKota(String kota) {
		this.kota = kota;
	}

	/**
	 * mendapatkan negara alamat
	 * @return the negara
	 */
	public String getNegara() {
		return negara;
	}

	/**
	 * mengubah nilai negara alamat
	 * @param negara
	 *             negara yang baru
	 */
	public void setNegara(String negara) {
		this.negara = negara;
	}

}

nah diatas itu contoh class Alamat yang ada javadocnya, dengan begitu pembacaan class akan mudah dimengerti, jadi orang lain yang akan menggunakan class yang kita gunakan gak akan terlalu pusing 😀

tapi javadoc yang asli itu berupa dokumentasi dengan format file html, dan jdk punya fasilitas untuk menggenerate javadoc, tapi gw saranin gunain aja fasilitas javadoc dari IDE yang lo pake, seperti Eclipse ato NetBeans biasanya dah punya fasilitas ini. dan kalo dah digenerate, hasilnya seperti ini :

image

nah lantas dimana kalo pengen dapet javadoc untuk dokumentasi class-class jse, nah tinggal liat aja disini :

http://java.sun.com/javase/6/docs/api/

ato kalo mo download javadoc jse bisa di :

http://java.sun.com/javase/downloads/index.jsp#docs

dan ini juga ada tambahan :

javadoc netbeans : http://bits.netbeans.org/dev/javadoc/index.html

Iklan

9 pemikiran pada “apa itu javadoc dan dimana downloadnya?

  1. yg penting itu setiap library yg kita gunakan sudah di-set source dan javadoc-nya. jadi kita tahu bagaimana menggunakan library tersebut. kalo malas silakan gunakan maven. selain mengambil jar-nya maven juga bisa mengambil source dan javadoc dan langsung men-set keduanya ke jar tsb.

  2. Ping balik: Belajar JaVa « WAHYU FIGHTER

  3. Ping balik: Tutorial Java dari Eko Kurniawan Khannedy « nge-WP@net

  4. boleh tanya dikit soal java ga? alnya aku dapat tugas tuk ngerjain beberapa tugas java, nieh!
    kalo mu buat program untuk nekonversiin bilangan biner ke oktal, atau sebaliknya gimana ya?

    harap dibalas ya…
    makasih

Tinggalkan Balasan

Isikan data di bawah atau klik salah satu ikon untuk log in:

Logo WordPress.com

You are commenting using your WordPress.com account. Logout / Ubah )

Gambar Twitter

You are commenting using your Twitter account. Logout / Ubah )

Foto Facebook

You are commenting using your Facebook account. Logout / Ubah )

Foto Google+

You are commenting using your Google+ account. Logout / Ubah )

Connecting to %s