ฉันจะทำเอกสารแพ็คเกจใน Java ได้อย่างไร?

182

ใน Java APIs ฉันสามารถเห็นความคิดเห็น Javadoc สำหรับแพ็คเกจ

ฉันจะวางความคิดเห็น Javadoc กับเอกสารแพคเกจได้อย่างไร?

java packages javadoc

257

ตั้งแต่ 1.5 คุณสามารถกำหนดpackage-info.javaไฟล์และจัดเตรียมความคิดเห็นสไตล์ javadoc มาตรฐานสำหรับแพ็กเกจ:

co.th / foo / package-info.java:

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

ข้อกำหนดภาษาสำหรับแพ็คเกจ

— Gareth Davis
แหล่งที่มา

3

ลิงก์โดยตรงไปยังข้อมูลจำเพาะ: docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1

— gavenkoa

7

ใน IntelliJ คุณสามารถคลิกขวาบนแพคเกจและเลือกที่จะสร้างนี้ควรจะเป็นใหม่ภายใต้เมนูแฟ้ม

— bsautner

ฉันพบไฟล์ที่จำเป็นต้องอยู่ใน packagename / src / packagename (ส่วนที่เหลือของไฟล์ที่มา)

— 24719

48

มากถึงและรวมถึง Java 1.4 คุณต้องจัดทำไฟล์ HTML package.html ดังที่อธิบายไว้ในคำตอบอื่น ๆ

ตั้งแต่ Java 1.5 คุณสามารถระบุ a package-info.javaซึ่งมีความคิดเห็น Javadoc ปกติ (ไม่มี HTML) อันหลังเป็นที่ต้องการเนื่องจากมันให้คุณสมบัติพิเศษบางอย่าง (โดยเฉพาะอย่างยิ่งคำอธิบายประกอบแพ็คเกจ)

รายละเอียด: เอกสารของซันสำหรับ javadoc

— sleske
แหล่งที่มา

2

+1 สำหรับการกล่าวถึงทั้งสองวิธีและความแตกต่างที่สำคัญระหว่างพวกเขา อย่างไรก็ตามอย่างน้อย IntelliJ IDEA ในปัจจุบันได้รับการสนับสนุน package.html ที่ดีกว่า (Ctrl-Q ในชื่อแพ็คเกจแสดงแพคเกจ Javadocs)

— Jonik

3

อัปเดตเป็นความคิดเห็นก่อนหน้าของฉัน: ปัจจุบัน IDEA รองรับได้package-info.javaดี

— Jonik

4

ด้วยpackage.htmlไฟล์ที่ระดับแพ็คเกจ (เช่นในไดเรกทอรีสำหรับแพ็คเกจนั้น) นี่ควรเป็นHTMLไฟล์ที่มีรูปแบบสมบูรณ์โดยมี<html>แท็กที่กำหนดไว้

— oxbow_lakes
แหล่งที่มา

1

รายละเอียดเพิ่มเติม? ไฟล์ควรมีลักษณะอย่างไร

— jjnguy

1

เป็นไฟล์ HTML ที่มีคำอธิบายแพ็คเกจของคุณ แค่นั้นแหละ!

— oxbow_lakes

3

นี่เป็นวิธีเก่าที่จะทำ จาก Java 1.5 เป็นต้นไปคุณสามารถใช้

— package-info.java