Ant - สร้างเอกสาร

เอกสารเป็นสิ่งจำเป็นในโครงการใด ๆ เอกสารมีบทบาทอย่างมากในการบำรุงรักษาโครงการ Java ทำให้การจัดทำเอกสารง่ายขึ้นด้วยการใช้งานในตัวjavadocเครื่องมือ. Ant ทำให้ง่ายยิ่งขึ้นด้วยการสร้างเอกสารตามความต้องการ

อย่างที่คุณทราบเครื่องมือ javadoc มีความยืดหยุ่นสูงและให้ตัวเลือกการกำหนดค่ามากมาย Ant แสดงตัวเลือกการกำหนดค่าเหล่านี้ผ่านงาน javadoc หากคุณไม่คุ้นเคยกับ javadocs เราขอแนะนำให้คุณเริ่มต้นด้วยJava Documentation Tutorialนี้

ส่วนต่อไปนี้แสดงรายการอ็อพชัน javadoc ที่ใช้บ่อยที่สุดที่ใช้ใน Ant

คุณลักษณะ

สามารถระบุแหล่งที่มาโดยใช้ sourcepath, sourcepathref หรือ sourcefiles.

• sourcepath ใช้เพื่อชี้ไปที่โฟลเดอร์ของไฟล์ต้นฉบับ (เช่นโฟลเดอร์ src)

• sourcepathref ใช้เพื่ออ้างถึงเส้นทางที่อ้างอิงโดยแอตทริบิวต์ path (เช่น delegates.src.dir)

• sourcefiles ใช้เมื่อคุณต้องการระบุไฟล์แต่ละไฟล์เป็นรายการที่คั่นด้วยจุลภาค

เส้นทางปลายทางถูกระบุโดยใช้ destdir โฟลเดอร์ (เช่น build.dir)

คุณสามารถกรองไฟล์ javadocงานโดยระบุชื่อแพ็กเกจที่จะรวม สิ่งนี้ทำได้โดยใช้ไฟล์packagenames แอตทริบิวต์รายการไฟล์แพ็กเกจที่คั่นด้วยจุลภาค

คุณสามารถกรองกระบวนการ javadoc เพื่อแสดงเฉพาะคลาสสาธารณะส่วนตัวแพ็กเกจหรือคลาสและสมาชิกที่ได้รับการป้องกัน สิ่งนี้ทำได้โดยใช้ไฟล์private, public, package และ protected คุณลักษณะ.

คุณยังสามารถบอกงาน javadoc ให้รวมข้อมูลผู้แต่งและเวอร์ชันโดยใช้แอตทริบิวต์ที่เกี่ยวข้อง

คุณยังสามารถจัดกลุ่มแพ็คเกจเข้าด้วยกันโดยใช้ไฟล์ group แอตทริบิวต์เพื่อให้ง่ายต่อการนำทาง

วางมันทั้งหมดเข้าด้วยกัน

ให้เราดำเนินการต่อธีม Hello worldแอปพลิเคชันแฟกซ์ ให้เราเพิ่มเป้าหมายเอกสารในโครงการแอปพลิเคชันแฟกซ์ของเรา

ด้านล่างนี้เป็นตัวอย่างงาน javadoc ที่ใช้ในโครงการของเรา ในตัวอย่างนี้เราได้ระบุ javadoc เพื่อใช้ไฟล์src.dir เป็นไดเร็กทอรีต้นทางและ doc เป็นเป้าหมาย

นอกจากนี้เรายังได้ปรับแต่งชื่อหน้าต่างส่วนหัวและข้อมูลส่วนท้ายที่ปรากฏบนหน้าเอกสาร java

นอกจากนี้เราได้สร้างกลุ่มสามกลุ่ม -

• หนึ่งสำหรับคลาสยูทิลิตี้ในโฟลเดอร์ซอร์สของเรา
• หนึ่งสำหรับคลาสอินเทอร์เฟซผู้ใช้และ
• หนึ่งสำหรับคลาสที่เกี่ยวข้องกับฐานข้อมูล

คุณอาจสังเกตเห็นว่ากลุ่มแพ็กเกจข้อมูลมีสองแพ็กเกจ -– faxapp.entity และ 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>

ให้เราดำเนินการภารกิจ javadoc Ant สร้างและวางไฟล์เอกสาร java ไว้ในโฟลเดอร์ doc

เมื่อ javadoc target ถูกดำเนินการจะให้ผลลัพธ์ดังต่อไปนี้ -

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

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

ขณะนี้ไฟล์เอกสาร java อยู่ในไฟล์ doc โฟลเดอร์

โดยทั่วไปไฟล์ javadoc จะถูกสร้างขึ้นโดยเป็นส่วนหนึ่งของรีลีสหรือแพ็กเกจเป้าหมาย