Javadoc yazılan kodun dökümantasyonunu isini kolaylastırmak icin ortaya cıkmıstır. Farklı platformlarda da calısırken gerekli acıklamayı metodun, paketin ve ya sınıfın uzerine yazma işini java kullananlar icin standartlaştırmıştır. Yapılan açıklamaları html formatına dönüştürmektedir.
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ı |