Ant - Dokümantasyon Oluştur

Herhangi bir projede dokümantasyon bir zorunluluktur. Belgeleme, bir projenin sürdürülmesinde büyük rol oynar. Java, yerleşik olanın kullanımıyla dokümantasyonu kolaylaştırırjavadocaracı. Ant, talep üzerine belgeleri oluşturarak bunu daha da kolaylaştırır.

Bildiğiniz gibi, javadoc aracı oldukça esnektir ve bir dizi yapılandırma seçeneğine izin verir. Ant, bu yapılandırma seçeneklerini javadoc görevi aracılığıyla gösterir. Javadocs'a aşina değilseniz, bu Java Dokümantasyon Eğitimi ile başlamanızı öneririz .

Aşağıdaki bölüm, Ant'ta kullanılan en sık kullanılan javadoc seçeneklerini listeler.

Öznitellikler

Kaynak kullanılarak belirtilebilir sourcepath, sourcepathref veya sourcefiles.

sourcepath kaynak dosyaların klasörüne işaret etmek için kullanılır (örn. src klasörü).
sourcepathref yol özniteliği tarafından başvurulan bir yola başvurmak için kullanılır (örneğin, delegates.src.dir).
sourcefiles tek tek dosyaları virgülle ayrılmış liste olarak belirtmek istediğinizde kullanılır.

Hedef yol, destdir klasör (ör. build.dir).

Filtreleyebilirsin javadocdahil edilecek paket adlarını belirterek görev. Bu,packagenames öznitelik, paket dosyalarının virgülle ayrılmış listesi.

Javadoc sürecini yalnızca genel, özel, paket veya korumalı sınıfları ve üyeleri gösterecek şekilde filtreleyebilirsiniz. Bu,private, public, package ve protected Öznitellikler.

Ayrıca javadoc görevine, ilgili öznitelikleri kullanarak yazar ve sürüm bilgilerini dahil etmesini de söyleyebilirsiniz.

Ayrıca paketleri kullanarak birlikte gruplayabilirsiniz. group özelliği, böylece gezinmesi kolay hale gelir.

Hepsini bir araya koy

Temamıza devam edelim Hello worldFaks uygulaması. Faks uygulama projemize bir dokümantasyon hedefi ekleyelim.

Aşağıda, projemizde kullanılan örnek bir javadoc görevi verilmiştir. Bu örnekte, javadoc'u kullanmak için belirledik.src.dir kaynak dizin olarak ve doc hedef olarak.

Ayrıca java dokümantasyon sayfalarında görünen pencere başlığı, üstbilgi ve altbilgi bilgilerini de özelleştirdik.

Ayrıca, üç grup oluşturduk -

kaynak klasörümüzdeki yardımcı program sınıfları için bir tane,
kullanıcı arayüzleri sınıfları için bir tane ve
veritabanı ile ilgili sınıflar için bir tane.

Veri paketi grubunun, faxapp.entity ve faxapp.dao olmak üzere iki pakete sahip olduğunu fark edebilirsiniz.

<target name = "generate-javadoc">
   <javadoc packagenames = "faxapp.*" sourcepath = "${src.dir}" 
      destdir = "doc" version = "true" windowtitle = "Fax Application">
      
      <doctitle><![CDATA[= Fax Application =]]></doctitle>
      
      <bottom>
         <![CDATA[Copyright © 2011. All Rights Reserved.]]>
      </bottom>
      
      <group title = "util packages" packages = "faxapp.util.*"/>
      <group title = "web packages" packages = "faxapp.web.*"/>
      <group title = "data packages" packages = "faxapp.entity.*:faxapp.dao.*"/>
   </javadoc>

   <echo message = "java doc has been generated!" />
</target>

Javadoc Ant görevini yapalım. Java dokümantasyon dosyalarını oluşturur ve doc klasörüne yerleştirir.

Ne zaman javadoc target yürütüldüğünde, aşağıdaki sonucu verir -

C:\>ant generate-javadoc
Buildfile: C:\build.xml

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

Java dokümantasyon dosyaları artık doc Klasör.

Genellikle javadoc dosyaları, sürümün veya paket hedeflerinin bir parçası olarak oluşturulur.