Skip to content
Menu
Kenan Erarslan
  • Hasscript
    • BİNlerce cevap
    • Hello world!
    • Hasscript motivasyonumuz
    • 60 soruyu geçtik
    • 50 Üye / 90 soru / 100 cevap.
    • 200 soru
    • 365 gün geride kaldı.
    • 2019’un Hasscript’i
  • Experience
    • How to select Right Programming Language For Next Project
    • BigData Study
      • Hadoop Learning Journey / 1 / What is Hadoop
      • Hadoop Study Part 2 – Meaningless Fight
      • Hadoop Learning Journey / 3 / Reinventing The Wheel
  • Türkçe
    • Apache Ant
      • Apache Ant – 1) Kurulum
      • Apache Ant – 2) Dosyaları derlemek
      • Apache Ant – 3) Özellik işleri (property tasks)
      • Apache Ant – 4) Özellik dosyaları
      • Apache Ant – 5) Veri tipleri
      • Apache Ant – 6) Proje derlemek
      • Apache Ant – 7) Döküman derlemek
      • Apache Ant – 8) Jar oluşturmak
    • Duygu / Düşünce
      • Ben bu işin neresindeyim?
      • Enkazlar ülkesi
      • Hayal kurmak güzeldir.
      • Arch Linux ile tanışmak ve zorluklar
Kenan Erarslan

Apache Ant – 7) Döküman derlemek

Posted on September 29, 2017April 17, 2020

Dökümantasyon her proje için mutlaka olması gereken parçalarından birisidir. Özellikle projenin sürümünün çıkmasından sonra destek verilmesi ve bakımının yapılması aşamalarında çok önemli bir rol oynamaktadır. Java standard paketinin içinde gelen javadoc aracı ile kolay döküman yazmak için bir altyapı sunmaktadır. Ant ile bu dökümantasyon işlemlerini otomatize etmek daha da kolaylaşmaktadır.

Bildiğiniz gibi, javadoc gayet esnek ve farklı seçeneklerle döküman oluşturabilme imkanı sunuyor. Ant bu özellikleri javadoc görevi ile bizim kullanımımıza sunuyor.
Aşağıda sık kullanılan javadoc özellikleri listelenmiştir.


Özellikler

Javadoc için verilecek olan dosyaların kaynağı sourcepath, sourcepathref ya da sourcefiles özellikleri ile belirlenebilir.

  • sourcepath özelliği dosyaların bulunduğu klasörü göstermek için kullanılır. Örnek: \src klasörü
  • sourcepathref tanımlanmış olan bir path özelliğini referans etmek için kullanılır. Örnek: dokuman.kaynak.dir
  • sourcefiles tek tek dosya belirlemek için kullanılır. Dosya isimleri virgül(,) ile ayrılmalıdır.

Hedef yolumuz ise destdir özelliği ile belirtilecektir. Örnek: derle.dir Eğer java paketleri bazında çıkaracağınız dökümanı filtrelemek isterseniz javadoc özelliği size bu imkanı sunacaktır. İşlemi yapabilmek için ise packagenames özelliği kullanılacaktır, paketleri aralarına virgül koyarak ayırabilirsiniz. İsterseniz group özelliğini kullanarak paketleri gruplayabilirsiniz. Böylelikle işlemler arasında gezinmek daha kolay olacaktır.

Uygulama koyulalım

Önceki bölümlerde oluşturduğumuz “Merhaba Dünya Projesi” üzerinden devam edelim ve projemizin içine dökümantasyon kodlarımızı da ekleyelim.

Aşağıda bir javadoc örneği verilmiştir. Bu örneğimizde, javadoc için kaynak klasörümüz olarak kaynak.dir ve hedef olarak da hedef.dir belirlenmiştir. Ayrıca çıkacak dökümanın title/header/footer özellikleri de belirlenmiştir. Kullanım kolaylığı olması açısından birkaç grup tanımlama örneği de eklenmiştir.

  • utility/yararlı sınıflar için bir grup
  • görsel arayüzler için bir grup
  • veritabanı ile ilgili sınıflar için bir grup

Fark edeceğiniz üzere veritabanı ile ilgili iki paket tanımlanmıştır.

<target name = "dokumantasyon">
   <javadoc packagenames="merhaba.*" sourcepath="${kaynak.dir}"
 destdir = "dokuman" version = "true" windowtitle = "Merhaba Dünya Projesi">
      <doctitle><![CDATA[= Merhaba Dünya Projesi =]]></doctitle>
      <bottom>
         <![CDATA[Copyright © 2011. All Rights Reserved.]]>
      </bottom>
      <group title = "yararli paketler" packages = "merhaba.util.*"/>
      <group title = "web paketleri" packages = "merhaba.web.*"/>
      <group title = "veri paketleri" packages = "merhaba.entity.*:merhaba.dao.*"/>
   </javadoc>
   <echo message = "java doc ile dökümanlar oluşturulmuştur!." />
</target>

Dökümantasyon kodlarımızı yazdıktan sonra ant dokumantasyon komutu ile çalıştırabilirsiniz.

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

4 × five =

March 2021
M T W T F S S
1234567
891011121314
15161718192021
22232425262728
293031  
« Feb    

RSS Hasscript.com | Programlama hakkında – Yeni soru ve cevaplar

  • npm proxy ayarlarını temizlemek nasıl yapılır?
  • Spring Security üzerinde bazı methodlara token olmadan nasıl erişebilirim?
  • Cevaplandı: Bir değerim var, sınıf tanımlamak istemiyorum. Nasıl tanımlayabilirim?
  • Spring security şifresiz login nasıl olabilirim?
  • Spring boot projesinde methodları rol bazlı nasıl ayırabilirim?
  • Cevaplandı: "No converter found capable of converting from type" hatası alıyorum, neden?
  • Cevaplandı: Spring data jpa için limit nasıl tanımlarım?
  • Cevaplandı: Java'da para değerlerini ne tarz değişkende tutmak mantıklıdır?
  • "There is no PasswordEncoder mapped for the id " hatası nasıl çözülür?
  • Cevaplandı: vuetify ile validasyonda 0 sorunu
©2021 Kenan Erarslan | WordPress Theme by Superbthemes.com