ตัวอย่างที่ดีของ Javadoc [ปิด]

มีตัวอย่างที่ดีของไฟล์ต้นฉบับที่มีJavadocหรือไม่

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

แล้วซอร์สโค้ดของ JDK นั้นเข้าถึงได้ผ่านบุคคลที่สามอย่าง docjar ไหม ยกตัวอย่างเช่นแหล่งที่มาของคอลเลกชัน

ด้วยวิธีนี้ไม่มีการดาวน์โหลดขนาดใหญ่

หน้าวิธีการเขียน Doc Coments สำหรับเครื่องมือ Javadocมีตัวอย่างที่ดีจำนวนมาก ส่วนหนึ่งเรียกว่าตัวอย่างความคิดเห็นของหมอและมีประเพณีไม่กี่

นอกจากนี้คำถามที่พบบ่อยของ Javadoc ยังมีตัวอย่างอีกหลายตัวอย่างเพื่อแสดงคำตอบ

แล้วซอร์สโค้ดของJDKล่ะ

ฉันใช้ชุดรูปแบบเอกสารขนาดเล็ก:

• จัดทำเอกสารเกี่ยวกับความปลอดภัยของเธรดเสมอ
• บันทึกการเปลี่ยนแปลงไม่ได้เสมอ
• javadoc พร้อมตัวอย่าง (เช่นตัวจัดรูปแบบ )
• @ Deprecation ด้วย WHY และ HOW เพื่อแทนที่องค์ประกอบที่มีคำอธิบายประกอบ

ดูที่ Spring Framework source มันมี javadocs ที่ยอดเยี่ยม

ANT ตัวอย่าง - ซอร์สโค้ดที่สามารถเรียกดูออนไลน์ได้: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

ในการเลือกไฟล์อื่น ๆ ให้เริ่มจาก: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/antools?antrev=761528

ดาวน์โหลดแหล่งที่มาของLuceneและดูว่าพวกเขาทำได้อย่างไร พวกเขามี JavaDocs ที่ดี

หากคุณกำลังใช้Eclipseคุณสามารถตั้งค่าJDKของคุณ(ไม่ใช่JRE ) ในJRE ที่ติดตั้งแล้วใช้Open Type ( Ctrl+ Shift+ T) ให้สิ่งที่ชอบjava.util.Collections

เอกสารของแพ็คเกจและคลาสEventBusของ Google Guava เป็นตัวอย่างที่ดีของ Javadoc โดยเฉพาะอย่างยิ่งเอกสารแพคเกจที่มีการเริ่มต้นอย่างรวดเร็วเขียนได้ดี

หากคุณติดตั้ง JDK และเลือกที่จะติดตั้งซอร์สเช่นกัน src.zip มีแหล่งที่มาของคลาส Java สาธารณะทั้งหมด ส่วนใหญ่เหล่านี้มี javadoc ที่ดีงาม

หากสิ่งที่คุณมองหาคือไวยากรณ์สิ่งนี้อาจช่วย:

วิธีเขียนความคิดเห็นเอกสารสำหรับเครื่องมือ Javadoc