Java Kitabı

** ile baĢlaması ve */ ile bitmesi gerekmektedir. Javadoc mekanizmasını kullanmanın iki etkili yolu
vardır. Bunlardan birincisi gömülü html (embedded html), ikincisi ise doc tags.
Doc tag ―@‖ ile baĢlarlar. Sınıfa, global değiĢkenlere ve yordamlara ait üç adet yorum dokümanı tipi
vardır. Verilen örnek Ģablon bunu açıklamaktadır.
Gösterim-1.21
/** A sınıf ait yorum */
public class DocTest {
/** i global değiĢkenin yorumu */
public int i;
/** isYap() yordamunun yorumu */
}
public void isYap() {}
Unutulmaması gereken baĢka bir nokta ise Javadoc varsayılan (default) public ve
protected olan üyelerin dokümanını üretir. private ve friendly üyelerin dokümantasyonu
yapmaz. Bunların sebeplerine ilerleyen konularda değineceğiz. Eğer private üyelere ait bilgilerinde
yazılmasına istiyorsak o zaman komut satırından,
$ javadoc a –private ……
ekini vererek bunu baĢarabiliriz.
Gömülü HTML (Embedded Html)
JavaDoc mekanizmasında kendinize ait HTML komutları kullanılması mümkündür:
Gösterim-1.22:
/**
*
* System.out.println("Selamlar");
*
*/
Gösterim-1.23:
/**
* Çok güzel hatta liste bile
yerleştirebilirsiniz:*
* madde bir
* madde iki
* Madde üç*
*/
gibi etiketlerini (tag) kullanmayın çünkü Javadoc bunları sizin yerinize zaten yerleĢtirmektedir.
Gömülü HTML özelliği sınıf, global değiĢkenler ve yordamlar tarafından desteklenir.
15