javadoc ne demek?

Javadoc Nedir?

Javadoc, Java kaynak kodundan API dokümantasyonu oluşturmak için kullanılan bir araçtır. Bu araç, özel biçimlendirilmiş yorum bloklarını (Javadoc etiketleri içeren) işleyerek HTML formatında, okunabilir ve arama yapılabilir bir dokümantasyon seti oluşturur. Javadoc, yazılımcıların kodun nasıl çalıştığını ve nasıl kullanılacağını kolayca anlamalarını sağlayarak, kodun yeniden kullanılabilirliğini ve bakımını artırır.

Temel İşlevleri:

API Dokümantasyonu Oluşturma: Java sınıfları, arayüzler, metotlar, alanlar ve yapıcılar hakkında detaylı bilgi sunan HTML sayfaları oluşturur.
Standart Bir Format Sağlama: Tüm Java projelerinde tutarlı ve kolay anlaşılır bir dokümantasyon standardı sağlar.
Kod Anlaşılabilirliğini Artırma: Kod içinde yer alan açıklamalar sayesinde, kodun ne yaptığını ve nasıl kullanıldığını açıkça belirtir.
Otomatik Dokümantasyon Üretimi: Derleme sürecinin bir parçası olarak dokümantasyonun otomatik olarak güncellenmesini sağlar.

Javadoc Etiketleri (Tags):

Javadoc, özel etiketler kullanarak dokümantasyonun içeriğini zenginleştirir. En sık kullanılan etiketlerden bazıları şunlardır:

@author: Sınıfın veya arayüzün yazarını belirtir.
@version: Sürüm numarasını belirtir.
@param: Metot parametrelerini tanımlar.
@return: Metotun dönüş değerini tanımlar.
@throws veya @exception: Metot tarafından fırlatılan istisnaları tanımlar.
@see: İlgili sınıf veya metotlara bağlantılar oluşturur.
@since: Özelliğin veya sınıfın hangi sürümde eklendiğini belirtir.
@deprecated: Kullanımdan kaldırılmış öğeleri işaretler ve neden kullanımdan kaldırıldığını belirtir.

Javadoc Kullanımı:

Javadoc yorumları, /** ... */ blokları içinde yer alır. Bu bloklar, sınıf, arayüz, metot veya alan tanımlarından hemen önce gelir. Örneğin:

/**
 * Bu sınıf, basit bir hesap makinesi işlevi görür.
 *
 * @author [Yazarın Adı]
 * @version 1.0
 * @since 1.0
 */
public class HesapMakinesi {

    /**
     * İki sayıyı toplar.
     *
     * @param a Toplanacak ilk sayı.
     * @param b Toplanacak ikinci sayı.
     * @return İki sayının toplamı.
     */
    public int topla(int a, int b) {
        return a + b;
    }
}

Javadoc Oluşturma:

Javadoc dokümantasyonunu oluşturmak için, Java Development Kit (JDK) ile birlikte gelen javadoc komut satırı aracını kullanabilirsiniz. Örneğin: