Javadoc, Java dilinde yazılım geliştiren programcıların kaynağın içine HTML formatlı bir dokümantasyon oluşturmasına imkan tanıyan dokümantasyon aracıdır. Javadoc’u kullanarak Java dilinde yazılım geliştirirken kodunuz için basit veya kapsamlı bir dokümantasyon oluşturabilirsiniz. Dokümantasyonlar sayesinde kodunuzu uzun bir süre sonra tekrardan düzenlemeniz gerektiğinde ya da ekip çalışmalarında daha efektif düzenleyebilirsiniz.
Yazılımcılar için dokümantasyon hazırlamak angarya bir iş gibi görünse bile temiz kodlama yapmanın yolu temiz dokümantasyonlardan geçiyor. Hazırlayacağınız basit ve hatırlatmalı dokümantasyonları kodu daha sonradan düzenlerken önemli bir hatırlatıcı olacaktır. Kodu sizden başka biri incelediğinde ve üzerinde değişiklik yapması gerektiğinde bu dokümantasyon kodlarını takip ederek kolayca düzenleyebilecektir.
Javadoc Nasıl Kullanılır?
Javadoc dokümantasyonlarını oluşturmak için “/**” ve “*” yorum açma ve kapatma satırları kullanılır. Sıradan yorum satırlarının aksine Javadoc’da dokümantasyonunuzu işlevsel kılmanıza yardımcı olan çeşitli etiket ve parametreler kullanılır. Bu parametre ve etiketlerin en çok kullanılanları şunlardır;
- Kodun yazarını belirtmek için “@auhor”
- Kodun versiyonunu belirtmek için “@version”
- Bir metod parametresi için “@param”
- Sonuç değeri için “@return”
- Bir diğer dokümantasyona link vermek için “@see”
- Metot istisnası ve açıklamasını belirtmek için “@exception”
- Metodun kod içindeki oluşturulma tarihi için “@since”
HTML Nedir? HTML Kodları ve HTML Dersleri
HTML (Hyper Text Markup Language), web üzerinde yayın yapabilecek sayfalar oluşturmak üzere kullanılabilen, Türkçe’ye ise zengin metin biçimlendirme dili olarak çevirilebilecek bir betik dilidir. HTML ile hazırlanan dosyalar *.html veya *...
Javadoc Örnekleri
Javadoc basit bir dokümantasyon aracı ancak yine de örneklere göz atarak yukarda verdiğimiz değerlerin ne şekilde kullanılabileceğine göz atmanız gerekiyor. Basit bir @ işareti koyduktan sonra değer oluşturabileceğimiz Javadoc’u nasıl kullanacağınızı merak ediyorsanız, aşağıdaki örnek çalışmamız size yeterli fikri sunacaktır.
/**
* WM Aracı Javadoc Kodu
*
* @author WMaracı
* @version 1.0
* @since 2017–01-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(“WM Aracı Javadoc Dokümantasyon Örneği”);
}
}
