จะสร้างไฟล์ Javadoc HTML ใน Eclipse ได้อย่างไร?


165

ฉันได้เขียนความคิดเห็นสไตล์ Javadoc เช่นนี้ในรหัสของโครงการของฉัน:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

ฉันจะสร้างไฟล์ Javadoc HTML โดยใช้ Eclipse IDE ได้อย่างไร


แนะนำสิ่งนี้ learnjava-soa.blogspot.com/2015/06/…
madhu

คำตอบ:


234
  1. Project> Generate Javadoc....

  2. ในJavadoc command:ฟิลด์เรียกดูเพื่อค้นหาjavadoc.exe (โดยปกติคือ[path_to_jdk_directory] \ bin \ javadoc.exe )

  3. ทำเครื่องหมายที่ช่องถัดจากโปรเจ็กต์ / แพ็คเกจ / ไฟล์ที่คุณกำลังสร้าง Javadoc

  4. ในDestination:ฟิลด์เรียกดูเพื่อค้นหาปลายทางที่ต้องการ (ตัวอย่างเช่นไดเรกทอรีรากของโครงการปัจจุบัน)

  5. Finishคลิก

ตอนนี้คุณควรจะสามารถค้นหา Javadoc ที่สร้างขึ้นใหม่ในโฟลเดอร์ปลายทาง เปิดindex.html


1
จำเป็นต้องติดตั้ง Java JDK หรือไม่ ฉันติดตั้ง Java และสามารถสร้างโปรแกรม Java ใน Eclipse ... แต่javadoc.exeไม่มีอยู่ในไดรฟ์ของฉัน!
AlainD

เก่า แต่สำหรับทุกคนในอนาคตที่อาจสับสนเกี่ยวกับเรื่องนี้ให้ตรวจสอบเพื่อดูว่าคุณมี JDK ติดตั้งตรงข้ามกับ JRE (ซึ่งไม่มี javadoc.exe ในตำแหน่งนี้)
omoshiroiii

9

นี่เป็นคำตอบเพิ่มเติมเกี่ยวกับ OP:

ทางออกที่ง่ายและเชื่อถือได้ในการเพิ่มความคิดเห็น Javadocs ใน Eclipse:

  1. ไป>HelpEclipse Marketplace...
  2. ค้นหา "JAutodoc"
  3. ติดตั้งและรีสตาร์ท Eclipse

JAutodocการใช้เครื่องมือนี้คลิกขวาบนชั้นและคลิกที่


7
AFAIK, JAutodoc ไม่ได้สร้าง HTML จากความคิดเห็น javadoc ที่มีอยู่ (ซึ่งเป็นคำถามที่ถาม) แต่จะช่วยสร้างความคิดเห็น javadoc
Amani Kilumanga

3
คำตอบไม่เกี่ยวข้องกับคำถาม แต่นี่คือสิ่งที่ฉันกำลังค้นหา :)
keya

Eclipse จะช่วยให้คุณสร้าง Javadocs: โครงการ -> สร้าง Javadocs ...
pongapundit

สิ่งนี้จะสร้าง javadoc ไม่ใช่ html ซึ่งเป็นคำถามที่เกี่ยวกับ
Ashish

5

คุณยังสามารถทำได้จากบรรทัดคำสั่งได้อย่างง่ายดายมาก

  1. เปิดบรรทัดคำสั่งจากโฟลเดอร์ / แพ็คเกจ
  2. จากการเรียกใช้บรรทัดคำสั่ง:

    javadoc YourClassName.java

  3. วิธีแบตช์สร้างเอกสารสำหรับหลายคลาส:

    javadoc * .java


2

ในการเพิ่ม Javadoc อย่างรวดเร็วให้ใช้ทางลัดต่อไปนี้:

Windows : alt+ shift+J

Mac : +Alt +J

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

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.