Java Dokümantasyon Html Render Oluşturma Rehberi
Herkese merhaba, Gerek benim ilk medium yazım olan, gerekse de şu an üzerinde konuşacağımız Java Documentation Html Render konusunun Yapı taşı olan Java Dokümantasyon Hazırlama Rehberi isimli yazımı okumanızı tavsiye ederim. Öyle ise başlayalım 🚩
Dokümantasyon İşleme Sayfası
açıkcası buna nasıl bir isim vereceğim konusunda epey düşündüm. Bunu en doğrusu ve uygunu gördüm. Çünkü Java kodlarımız içerisinde oluşturduğumuz dokümantasyonları her zaman oradan okumayız, okutmayız veya işlemler yapmayız. Bunun için genellikle IDE’nin bize sağladığı kolaylıklardan faydalanıp, bu dokümantasyonları bir arada görebileceğimiz, WEB SAYFALARI render ederiz.
Aşağıda nasıl bir sayfadan bahsettiğimizi ekledim.
Nasıl Generate Ederiz ?
hiç uzatmadan hemen nasıl yapacağımızı görseller ile anlatacağım.
ilk olarak java doküman kodlarımızı yazdıktan sonra;
Intellij Idea IDE mizde Tools Sekmesine Tıklıyoruz ardından Generate JavaDoc… sekmesine Tıklıyoruz.
Ardından açılan Sayfada Tüm projemin dokümanlarını istediğimi belirtiyorum. ardından output directory ayarlarımı seçiyorum, kalan default ayarlara dokunmadan OK butonuna basıyorum.
hemen ardından belirlediğim output directory de HTML Dosyalarımın ve DOM için gerekli javascript dosyalarının oluştuğunu görüyorum.
Oluşturulan Web Sayfalarını Tanıyalım 🥳
Header kısmında bizi Package, Class, Tree ve index sekmeleri karşılıyor.
Package : Paketin içerisinde ki Classları ve aynı dizinde ki ilişkili paketleri listeler.
Class : Sınıf içerisinde ki yazdığımız doc lar ve sınıf hakkında genel bilgi verilen sekmedir.
Tree : Paketin içerisinde ki Hiyerarşi düzenini gösterir.
Index: Alfabetik olarak bir düzene sokar.
Örnek Bir Class
Java Kodumuz içerisinde yazdığımız getDummyDatas methodu bakalım Web Sayfasında nasıl gözüküyor.
Sınıfın Geri kalanı için…
Geri kalan kısımları, kendi projenizin dokümantasyonunu hazırlayarak kendiniz tecrübe etmeniz en büyük temennim. bu noktada elimden geldiğinde sizlere rehberlik etmeye çabaladım.
Herkese iyi Çalışmalar..
