16.JavaDOC ile Otomatik Döküman Oluşturma
Java uygulamalarında özellikle takım çalışmalarında döküman oluşturulması çok önemlidir. Çünkü bu tarz ortamlarda bir çok şey hazırdır ve hazırın öğrenilmesi ayrı bir zaman almaktadır. Çoğu durumda kodlar elimizde olsa bile koda bakarak ne yapıldığını anlamak o kadar kolay olmayabilir. İşte bu sebeple java standart araçları arasında JavaDoc denilen bir program yardımıyla ve yorum satırları kullanılarak, bir takım bilgiler Java Oracle dökümantasyonu şeklinde çıkartılabilmektedir. Bunun için JavaDoc içerisinde kullanılan bir takım anahtar sözcükler kullanılmaktadır. Bu anahtar sözcükler yorum satırları içerisinde anlamlı olmaktadır. Bu anahtar sözcükler şunlardır;
Anahtar Sözcükler | Anlamı |
---|---|
@Author | Yazar Adı |
@CodeText | Kod fontu formatında text'in gösterilmesi |
@Deprecated | Deprecated bildirimi |
@Exception, @Throws | Fırlatılan exceptionlar |
@Return | Bir metodun geri dönüş değeri |
@Serial | Seri edilebilen veri elemanının bildirimi |
@Since | JDK içerisinde ne zamandan beri var olduğu bilgisi |
@Version | Versiyon numarası |
@param | Metodun parametre değeri |
JavaDoc programı komut satırından kullanılabildiği gibi IDElerin bir çoğunda buna ilişkin menuler bulunmaktadır.
JavaDoc ile döküman oluşturmak için gereken yorum satırları başlangıcı /**
olmalıdır. Tüm kullanılacak olan anahtar sözcüklere ilişkin satırlar yıldız ile başlamalıdır.
/*
*
*/
JavaDoc yorum satırları içerisinde anahtar sözcük kullanılmadan yazılan yazılar dökümantasyona dahil edilir. Eclipse idesinin project menusu altında generate javadoc ile dökümantasyondan yapılabilmektedir. Açılan pencerede JavaDoc comment bölümünde JavaDoc programının dosya yolu belirtilmelidir.
Threadlerin Senkronizasyonu
Bilindiği gibi Thread akışının ayrı bir stack alanı ve ortak bir heap alanı bulunmaktadır. Buna göre bir thread akışı içerisinde bulunan yerel değişken farklı 2 akış tarafından ortak olamaz, yani bir metod için yerel değişkenler her thread için farklı yaratılmaktadır.