Bir uygulamanın temel taşlarından birisi de dökümantasyondur. Temel taşlarından biri olmasına rağmen bir o kadar da yorucu ve sıkıcı olabilir; ama eğer Javadoc kullanırsanız bu iş artık bir eğlence olmaya başlar. Javadoc ile kod aralarına yazdığınız yorumlar bir dökümantasyon dili olarak anlamlandırılır ve html çıktısı üretilir. Önce örnek bir kod vermek istiyorum, daha sonra detaylı şekilde bakalım.

package com.farukbozan.ornekler.javadoc;/**
* Bu bir javadoc örneği için oluşturulmuş sınıftır.
* @author Faruk BOZAN
* @since 12.04.2010
* @version 1.0.0.1
*/
public class Javadoc {/**
* Sınıf içerisinde bir değişken tanımladık.
*/
public String javadocDegiskeni;
/**
* Bu da final değişken. Javadoc üzerinde değeri görülebilir.
*/
public final int FINAL_DEGISKEN = 12;

/**
* Bölme işlemi metodu
* @param deger1 Bölünen sayı
* @param deger2 Bölen sayı
* @return Bölme işleminin sonucu döndürülür
* @throws ArithmeticException deger2 sıfır olursa hata oluşur
*/
public double bolmeIslemi(double deger1, double deger2) throws ArithmeticException
{
return deger1 / deger2;
}

}

Öncelikle sınıf tanımı üzerinde bir satırlık yorumumuz var ve gelen satırlarda anahtar kelimelerle beraber yazarı, yazım tarihini ve versiyon numarasını belirtiyoruz.  Daha sonra değişkenlerimiz için javadoc satırları yazıyoruz. Bunlardan biri final değişken dolayısıyla uygulama boyunca bir değeri var ve javadoc üzerinde bu değeri görebiliyoruz. Daha sonra bir bölme işlemi metodu tanımladık ve tek satırlık yorum ekledik. Birden fazla satır da olabilir. İhtiyacınıza bağlı bu durum. Daha sonra alınan parametreler hakkında javadoc ekliyoruz. Bildiğiniz gibi bölme işleminde payda sıfır olursa tanımsız olur ve uygulama kırılır. Dolayısıyla biz de böyle bir durumla karşılaşınca throws ifadesi ile hata fırlatılabileceğini belirtiyoruz. Bu hatayı yine javadoca işliyoruz. Anahtar kelime ve hata türünden sonra açıklamamızı yapıyoruz. Son dikkat edilmesi gereken nokta yorumlar /** ve */ ifadeleri arasına yazılmaktadır.

Bu örneği NetBeans üzerinde oluşturdum. Dolayısıyla projeye sağ tıklayıp Generate Javadoc komutunu verirseniz, bir müddet sonra karşınıza html sayfası açılacaktır ve yazdığınız yorumların nasıl bir etki bıraktığını keyifle izleyebilirsiniz.

Bol Java’ lı günler dileğiyle…

Categories:

2 Responses

  1. Merhabalar. Javadoc hakkında hiç bir fikrim olmamasına rağmen yazınız sayesinde cogu seyi öğrenmiş oldum. Teşekkürler 🙂

Bir cevap yazın

E-posta hesabınız yayımlanmayacak.