Javadoc Nedir?

Javadoc, Java programlama dilinde API (Application Programming Interface) dokümantasyonu oluşturmak için kullanılan bir araçtır. Javadoc, kaynak kodunuzun içine özel yorum etiketleri eklemenizi sağlar ve bu etiketlerden otomatik olarak API dokümantasyonunu oluşturur.

Javadoc: Java API Dokümantasyonu

Java programlama dilinde, büyük projeler geliştirirken kodun anlaşılması ve kullanılması için iyi bir dokümantasyon önemlidir. Javadoc, Java geliştiricilerine API’lerini belgelemeleri için etkili bir araç sunar. Javadoc ile oluşturulan dokümantasyon, API’nin kullanıcılarına fonksiyonlar, sınıflar, arayüzler ve diğer bileşenler hakkında ayrıntılı bilgiler sağlar.

Javadoc Kullanımı

Javadoc’i kullanmak için aşağıdaki adımları izleyebilirsiniz:

1. Javadoc Yorumları

Javadoc, belgelendirilmek istenen kodun üzerine eklenen özel yorum etiketleri kullanır. Javadoc yorumları, ” /** ” ile başlar ve ” */ ” ile biter. Aşağıda basit bir örnek verilmiştir:

/**
 * Bu sınıf, matematiksel işlemler yapmak için kullanılır.
 */
public class Matematik {
    // ...
}

2. Etiketlerin Kullanımı

Javadoc yorumlarında kullanılan etiketler, belgelemek istediğiniz bileşenin türüne göre değişir. İşte bazı yaygın kullanılan Javadoc etiketleri:

• @param: Bir metodun parametrelerini açıklar.
• @return: Bir metodun dönüş değerini açıklar.
• @throws: Bir metodun atabileceği istisnaları açıklar.
• @see: Diğer sınıflar, metotlar veya alanlarla ilişkilendirme yapar.
• @since: Bir metodu veya sınıfı belirli bir sürümle tanımlar.
• @deprecated: Bir metodun veya sınıfın kullanımının tavsiye edilmediğini belirtir.

/**
 * İki sayının toplamını bulur.
 * 
 * @param sayi1 İlk sayı
 * @param sayi2 İkinci sayı
 * @return İki sayının toplamı
 */
public int toplama(int sayi1, int sayi2) {
    return sayi1 + sayi2;
}

3. Javadoc Dokümantasyonunun Oluşturulması

Javadoc yorumları yazıldıktan sonra, dokümantasyonu oluşturmak için javadoc aracı kullanılır. Aşağıdaki komutu kullanarak Javadoc dokümantasyonunu oluşturabilirsiniz:

javadoc -d belge_klasoru -sourcepath kaynak_klasoru dosya1.java dosya2.java ...

4. Javadoc Dokümantasyonunun Kullanımı

Oluşturulan Javadoc dokümantasyonu, web tarayıcısı aracılığıyla görüntülenebilir. Belge klasöründeki index.html dosyasını açarak API dokümantasyonuna erişebilirsiniz. API dokümantasyonunda sınıflar, metotlar, alanlar ve diğer bileşenler hakkında ayrıntılı açıklamalar ve kullanım örnekleri bulunur.

Javadoc ile Örnek

/**
 * Bu sınıf, bir dikdörtgenin alanını ve çevresini hesaplamak için kullanılır.
 */
public class Dikdortgen {
    private int en;
    private int boy;

    /**
     * Dikdörtgen sınıfının yapıcı metodudur.
     * 
     * @param en  Dikdörtgenin eni
     * @param boy Dikdörtgenin boyu
     */
    public Dikdortgen(int en, int boy) {
        this.en = en;
        this.boy = boy;
    }

    /**
     * Dikdörtgenin alanını hesaplar.
     * 
     * @return Dikdörtgenin alanı
     */
    public int alanHesapla() {
        return en * boy;
    }

    /**
     * Dikdörtgenin çevresini hesaplar.
     * 
     * @return Dikdörtgenin çevresi
     */
    public int cevreHesapla() {
        return 2 * (en + boy);
    }
}

Yukarıdaki örnekte, Javadoc yorumları kullanılarak Dikdortgen sınıfı belgelenmiştir. @param, @return ve diğer etiketler kullanılarak metodlar açıklanmış ve kullanımı belirtilmiştir.

Javadoc, Java geliştiricilerinin kodlarını anlaşılır ve kullanımı kolay bir şekilde belgelemelerini sağlar. API dokümantasyonu oluşturmanın yanı sıra, Javadoc ile projelerinizin daha kolay anlaşılmasını ve bakımını yapmanızı sağlar.

Umarım bu makale, Javadoc’in ne olduğunu, nasıl kullanıldığını ve nasıl API dokümantasyonu oluşturulduğunu detaylı bir şekilde açıklar.