Ant - Bangun Dokumentasi

Dokumentasi adalah suatu keharusan dalam proyek apa pun. Dokumentasi memainkan peran besar dalam pemeliharaan proyek. Java membuat dokumentasi lebih mudah dengan menggunakan built-injavadocalat. Ant membuatnya lebih mudah dengan membuat dokumentasi sesuai permintaan.

Seperti yang Anda ketahui, alat javadoc sangat fleksibel dan memungkinkan sejumlah opsi konfigurasi. Ant memperlihatkan opsi konfigurasi ini melalui tugas javadoc. Jika Anda tidak terbiasa dengan javadocs, kami sarankan Anda memulai dengan Tutorial Dokumentasi Java ini .

Bagian berikut mencantumkan opsi javadoc yang paling umum digunakan yang digunakan di Ant.

Atribut

Sumber dapat ditentukan menggunakan sourcepath, sourcepathref atau sourcefiles.

sourcepath digunakan untuk menunjuk ke folder dari file sumber (mis. folder src).
sourcepathref digunakan untuk merujuk jalur yang direferensikan oleh atribut jalur (misalnya, delegates.src.dir).
sourcefiles digunakan saat Anda ingin menentukan file individual sebagai daftar yang dipisahkan koma.

Jalur tujuan ditentukan menggunakan destdir folder (misalnya build.dir).

Anda bisa memfilter javadoctugas dengan menentukan nama paket yang akan disertakan. Ini dicapai dengan menggunakanpackagenames atribut, daftar file paket yang dipisahkan koma.

Anda dapat memfilter proses javadoc untuk hanya menampilkan kelas dan anggota publik, privat, paket, atau dilindungi. Ini dicapai dengan menggunakanprivate, public, package dan protected atribut.

Anda juga dapat memberi tahu tugas javadoc untuk menyertakan penulis dan informasi versi menggunakan atribut masing-masing.

Anda juga bisa mengelompokkan paket bersama menggunakan group atribut, sehingga menjadi mudah dinavigasi.

Menyatukan semuanya

Mari kita lanjutkan tema kita dari Hello worldAplikasi faks. Mari kita tambahkan target dokumentasi ke proyek aplikasi Faks kita.

Diberikan di bawah ini adalah contoh tugas javadoc yang digunakan dalam proyek kami. Dalam contoh ini, kami telah menetapkan javadoc untuk menggunakan filesrc.dir sebagai direktori sumber, dan doc sebagai target.

Kami juga telah menyesuaikan informasi judul jendela, header, dan footer yang muncul di halaman dokumentasi java.

Juga, kami telah membuat tiga grup -

satu untuk kelas utilitas di folder sumber kami,
satu untuk kelas antarmuka pengguna, dan
satu untuk kelas terkait database.

Anda mungkin memperhatikan bahwa grup paket data memiliki dua paket - faxapp.entity dan faxapp.dao.

<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>

Mari kita jalankan tugas Ant javadoc. Ini menghasilkan dan menempatkan file dokumentasi java di folder doc.

Ketika javadoc target dieksekusi, itu menghasilkan hasil sebagai berikut -

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

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

File dokumentasi java sekarang ada di doc map.

Biasanya, file javadoc dibuat sebagai bagian dari rilis atau target paket.