การสร้าง Javadoc

ตัวช่วยสร้าง เปิดตัวช่วยสร้าง Javadoc การสร้าง Javadoc อนุญาตให้คุณสร้าง Javadoc ซึ่งเป็นส่วนติดต่อผู้ใช้สำหรับเครื่องมือ javadoc.exe ที่มีอยู่ใน Java JDK เยี่ยมชมเพจ Sun's Javadoc Tool เพื่อดูเอกสารคู่มือฉบับสมบูรณ์ของเครื่องมือ Javadoc

หน้าแรก

การเลือกชนิด:

อ็อพชัน

คำอธิบาย

คำสั่ง Javadoc

ระบุคำสั่งที่ต้องการใช้เพื่อสร้าง javadoc

เลือกชนิดที่จะสร้าง Javadoc

ในรายการ ให้ทำเครื่องหมายหรือล้างข้อมูลในกล่องเพื่อระบุชนิดที่แน่นอนซึ่งคุณต้องการเอ็กซ์พอร์ต รายการนี้ถูกเตรียมข้อมูลเบื้องต้นโดยการเลือก workbench

สร้าง Javadoc สำหรับสมาชิกที่มีทัศนวิสัย

  • ไพรเวต: สมาชิกทั้งหมดจะถูกจัดทำเป็นเอกสาร
  • แพ็กเกจ: เฉพาะสมาชิกที่มีทัศนวิสัยดีฟอลต์ แบบป้องกัน หรือแบบพับลิกเท่านั้นที่จะถูกจัดทำเป็นเอกสาร
  • ป้องกัน: เฉพาะสมาชิกที่มีทัศนวิสัยแบบป้องกันหรือแบบพับลิกเท่านั้นที่จะถูกจัดทำเป็นเอกสาร
  • พับลิก: เฉพาะสมาชิกที่มีทัศนวิสัยแบบพับลิกจะถูกจัดทำเป็นเอกสาร (ดีฟอลต์)


ใช้ doclet มาตรฐาน

เริ่มคำสั่ง Javadoc ที่มี doclet มาตรฐาน (ดีฟอลต์) 

  • ปลายทาง: เลือกปลายทางที่ doclet มาตรฐานจะเขียนเอกสารที่สร้างขึ้น ปลายทางคือ doclet ที่ระบุเฉพาะอาร์กิวเมนต์ และไม่เปิดใช้งานเมื่อใช้ doclet แบบกำหนดเอง


ใช้ doclet แบบกำหนดเอง

ใช้ doclet แบบกำหนดเองเพื่อสร้างเอกสารคู่มือ 

  • ชื่อ Doclet: ชื่อชนิดที่ผ่านการรับรองของ doclet
  • Doclet class path: Classpath ที่จำเป็นต่อคลาส doclet


อาร์กิวเมนต์ doclet มาตรฐาน

อาร์กิวเมนต์ Doclet มาตรฐาน (พร้อมใช้งานเมื่อเลือก ใช้ doclet มาตรฐาน):

อ็อพชัน

คำอธิบาย

หัวเรื่องเอกสาร

ระบุหัวเรื่องเอกสาร
สร้างหน้าการใช้งาน อ็อพชันนี้ที่เลือกไว้หากคุณต้องการให้เอกสารคู่มือมีหน้า การใช้งาน
สร้างลำดับชั้นแบบทรี เลือกอ็อพชันนี้หากคุณต้องการให้เอกสารคู่มือมีหน้าแบบทรี

สร้างแถบเนวิเกเตอร์

เลือกอ็อพชันนี้หากคุณต้องการให้เอกสารคู่มือมีแถบเนวิเกเตอร์ (ส่วนหัวและส่วนท้าย)
สร้างดัชนี เลือกอ็อพชันนี้หากคุณต้องการให้เอกสารคู่มือมีหน้าดัชนี
แยกดัชนีต่อตัวอักษร สร้างดัชนีต่อตัวอักษร เปิดใช้งานเมื่อเลือก สร้างดัชนี 
@author เลือกอ็อพชันนี้หากคุณต้องการให้แท็ก @author ถูกจัดทำเป็นเอกสาร
@version เลือกอ็อพชันนี้หากคุณต้องการให้แท็ก @version ถูกจัดทำเป็นเอกสาร
@deprecated เลือกอ็อพชันนี้หากคุณต้องการให้แท็ก @deprecated ถูกจัดทำเป็นเอกสาร
รายการที่ถูกคัดค้าน เลือกอ็อพชันนี้หากคุณต้องการให้เอกสารมีหน้า ถูกคัดค้าน เปิดใช้งานเมื่อเลือกอ็อพชัน @deprecated
เลือกไฟล์เก็บถาวรและโปรเจ็กต์ที่อ้างถึงซึ่งมีลิงก์ที่ควรถูกสร้างขึ้น ระบุว่าเอกสารคู่มือ Javadoc อื่นควรสร้างลิงก์เมื่ออ้างถึงชนิดอื่น 
  • เลือกทั้งหมด: สร้างลิงก์ไปยังตำแหน่งเอกสารคู่มืออื่นๆ ทั้งหมด
  • ล้างข้อมูลทั้งหมด: ห้ามสร้างลิงก์ไปยังตำแหน่งเอกสารคู่มืออื่น
  • ปรับแต่ง: ปรับแต่งตำแหน่ง Javadoc ของ JAR หรือโปรเจ็กต์ที่อ้างถึง
สไตล์ชีต เลือกสไตล์ชีตที่ต้องการใช้

อาร์กิวเมนต์ทั่วไป

อ็อพชัน Javadoc ทั่วไป:

อ็อพชัน

คำอธิบาย

ภาพรวม

ระบุว่า Javadoc ควรดึงข้อความสำหรับภาพรวมของเอกสารคู่มือจากไฟล์ที่กำหนดไว้ ซึ่งจะวางอยู่ใน overview-summary.html

อ็อพชัน VM

เพิ่มตัวเลขใดๆ ของอ็อพชัน VM พิเศษที่นี่

อ็อพชัน Javadoc พิเศษ

เพิ่มตัวเลขใดๆ ของอ็อพชันพิเศษที่นี่: อ็อพชัน doclet แบบกำหนดเองหรืออ็อพชันความเข้ากันได้กับ JRE 1.4
โปรดสังเกตว่า อาร์กิวเมนต์ที่มีช่องว่างต้องล้อมรอบด้วยเครื่องหมายอัญประกาศ สำหรับอาร์กิวเมนต์ที่ระบุโค้ด html (เช่น -header) ให้ใช้ &  หรือ &" เพื่อหลีกเลี่ยงช่องว่าและ เครื่องหมายอัญประกาศ

ความเข้ากันได้กับซอร์ส JRE

ความเข้ากันได้กับซอร์ส JRE ที่ต้องถูกยอมรับโดยเครื่องมือ javadoc

บันทึกค่าติดตั้งของ Javadoc นี้ที่เอ็กซ์พอร์ตเป็นสคริปต์ Ant

ระบุเพื่อเก็บสคริปต์ Ant ที่จะดำเนินการเอ็กซ์พอร์ต Javadoc ที่ระบุไว้โดยไม่จำเป็นต้องใช้ตัวช่วยสร้าง สคริปต์ Ant ที่มีอยู่สามารถปรับเปลี่ยนได้ด้วยตัวช่วยสร้างนี้ (ใช้เปิดตัวช่วยสร้าง Javadoc' จากเมนูบริบทบนสคริปต์ Ant ที่สร้างขึ้น)

เปิดไฟล์ดัชนีที่สร้างขึ้นในเบราว์เซอร์ เปิดไฟล์ index.html ที่สร้างขึ้นในเบราว์เซอร์ (พร้อมใช้งานเมื่อใช้ doclet มาตรฐานเท่านั้น)

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

กระบวนการใหม่จะถูกเริ่มทำงานและการสร้างจะถูกดำเนินการในแบ็กกราวน์ เปิด มุมมองคอนโซล (หน้าต่าง > แสดงมุมมอง > คอนโซล) เพื่อดูความคืบหน้า และสถานะของการสร้าง

การอ้างถึงที่เกี่ยวข้อง

การดำเนินการกับไฟล์
คุณสมบัติตำแหน่ง Javadoc