Comment Pada Java

Comment pada setiap bahasa pemrogramman sangatlah lah penting untuk dokumentasi program yang kita buat, namun sering kali kita melupakannya.

Taukah kamu kalo pada java terdapat 3 jenis comment.

1.

// comment on one line

2.

/* comment on one
* or more lines
*/

3.

/** documentation comment
* can also span one or more lines
*/

Untuk jenis 1 dan 2 mungkin sudah tidak asing lagi bagi kita, namun untuk yang jenis 3 apakah yang dimaksud dengan documentation comment?

Untuk lebih jelas, mari langsung kita praktekan. Pada sebuah project java buatlah sebuah class java dengan nama ContohComment, maka akan tampak sebagai berikut:

Lalu coba di rubah documentation comment tersebut sesuai keinginan, untuk sekarang coba di rubah seperti berikut:

/**
* Class Contoh Comment
* @author SONY
*/

Lalu pada class ContohComment tulis main fungsi sebagai berikut:

public static void main(String args[]){
ContohComment c = new ContohComment();
}

Lalu tekan ctrl + space diantara tulisan ContohComment hingga keluar tulisan berikut:

Dari contoh tersebut dapat kita simpulkan bahwa pada dengan menggunakan documentation comment kita dapat menulis tentang class yang kita buat, apa fungsi dan kegunaannya sehingga jika ada programmer lain yang ingin menggunakan class tersebut dapat mengerti.

Selain untuk class kita juga dapat membuat sebuah documentation comment untuk setiap Constructor atau method yang kita buat, contohnya:

/**
* Constructor 1
*/
public ContohComment(){

}

/**
* Constructor 2
* @param i
*/
public ContohComment(int i){

}

/**
* Contoh Method 1
*/
public void method1(){

}

/**
* Contoh method 2
* @param i
*/
public void method2(double i){

}

Sehingga pada saat pemanggilan constructor atau method pada object yang merujuk ke class tersebut kita dapat melihat documentation yang telah ditulis dengan menekan ctrl + space, seperti:

Untuk keterangan lebih lanjut dapat dilihat pada link berikut:
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s