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.

Etiket Açıklama Syntax
@author Class’ı yazan kisi @author burakkutbay
{@code} Metodun kullanım örneğini vermek için {@code …}
@exception Metot istisnası ve açıklaması @exception istisna açıklama
@param Değişkenler, değişken tipleri ve bu değişkenlerin açıklamaları @param değişken – açıklama
@return Metottan bir değer dönüyorsa açıklaması @return açıklama
@see Başka bir metod ya da açıklamaya referans göstermek için kullanılır @see referans
@since Metodun oluşturma tarihi @since tarih
@version Sınıfın version numarası @version version numarası

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.

Projeyi Github Üzerinden Görüntüle

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.

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

javadocgenerate1

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.

javadocgenerate2

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

jaavadocexample

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.

 

Projeyi Github Üzerinden Görüntüle

Bir Cevap Yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir