Javadoc Nedir? Kullanımı

Dökümantasyon… Yazmayı sevmediğimiz bir iş olsa da zaman geçtiğinde kendi yaptığımız yazılımın kodlarını incelerken anlamakta zorluk çekerken yardımımıza koşar dökümantasyon.  Yazılımcı dökümantasyonu bir metodun ya da değişkenlerin tam olarak ne yaptığını anlamak için kullandığımız bir yardım çantasıdır. Bu yardım çantasını oluşturmanın çok eğlenceli bir yolu olan JavaDoc‘tan bahsedeğim.

Javadoc, Java yazılım projelerinde yazılım dökümantasyonu yazmak için belirli bir format sunar ve bu format html olarak görüntülenir kolaylıkla içerisinde gezinebilir bir yapı oluşur.

Yazılım aralarında kullanılan yorum alanları arasına belirli formatta yazabileceğiniz Javadoc gün sonunda kullanılabilir bir dökümantasyon sağlamaktadır.

Javadoc yazmak için

/**
*
*
*/

tagları arasına yazmamız gerekmektedir. Kullandığınız IDE’ye göre değişkenlik gösterese de /** + Enter tuşlarına basarak otomatik bir Javadoc yorum alanı açabilirsiniz. Bu yorum alanına Javadoc etiketlerini kullanarak metotlarınızı, classlarını detaylıca açıklayabilirsiniz. Benim sıkça kullandığım bazı Javadoc etiketlerini aşağıda bulabilirsiniz. Aşağıda yazdığımdan biraz daha fazla etiket olduğunu belirtiyeyim.

Yukarıda belirttiğim etiketleri yorum alanına yazarak Javadoc oluşturmak için gerekli adımı atmış oluruz. Bunu bir örnekle açıklayalım.

/**
 * Bu bir JavaDoc Örneğidir.
 *
 * @author burakkutbay
 * @version 1.0.0
 * @since  2016-11-12
 */
public class Main {

    /**
     * Topla metodu iki sayıyı toplar ve sonucu döndürür.
     * @param sayi1 toplama işlemi için ilk sayı
     * @param sayi2 toplama işlemi için ikinci sayı
     * @return sonuc integer veri tipinde döndürür
     */
    public int topla(int sayi1, int sayi2){
        int sonuc=sayi1+sayi2;
        return sonuc;
    }

    public static void main(String[] args) {
        System.out.println("Javadoc Örneği -- Burak KUTBAY");

    }
}

[otw_shortcode_button href=”https://github.com/BrkSe/JavaDoc_Example” size=”medium” icon_type=”social foundicon-github” icon_position=”left” shape=”radius” target=”_blank”]Projeyi Github Üzerinden Görüntüle[/otw_shortcode_button]

Biz yazılımımızı yaptık ve gerekli alanlarda Javadoc şablonu kullanarak  metodumuz ve classımız hakkında gerekli açıklamaları yaptık.  Javadoc formatında yazdığımız bu classımızdan bir dökümantasyon elde etmek istersek yapmamız gereken. Bilgisayarımızın konsol ekranını açıp classımızın bulunduğu dizine giderek aşağıdaki komutu yazmak yeterli olucaktır.

javadoc -d doc Main.java

Eğer Intellij IDEA kullanıyorsanız IDE üzerinden bu işlemi daha kolay gerçekleştirebilmeniz mümkün.

Ardından çıkan menüde gerekli ayarlamaları yapıp bu dökümantasyonu elde etmeniz mümkün. Bu ayarlamada hangi türde sınıflar dökümantasyonda gözükebilir gibi çeşitli ayarlamalar yapabiliyorsunuz.

Bu işlemlerin ardından ortaya çıkan sonuç ise aşağıdaki gibi olmaktadır.

Projemizde yazdığımız tüm Javadoc yorumlarını olşuturarak bir html dökümantasyonu haline getirerek içerisinde gezinebilir halde bir dosya oluşmuş oluyor.

[otw_shortcode_button href=”https://github.com/BrkSe/JavaDoc_Example” size=”medium” icon_type=”social foundicon-github” icon_position=”left” shape=”radius” target=”_blank”]Projeyi Github Üzerinden Görüntüle[/otw_shortcode_button]