जवाबों:
1.5 के रूप में आप एक package-info.java
फ़ाइल को परिभाषित कर सकते हैं और एक पैकेज के लिए एक मानक javadoc शैली टिप्पणी प्रदान कर सकते हैं :
com / 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
जावा 1.4 तक और इसमें शामिल, आपको एक HTML फ़ाइल package.html प्रदान करनी थी, जैसा कि अन्य उत्तरों में वर्णित है।
Java 1.5 के बाद से आप एक भी प्रदान कर सकते हैं package-info.java
, जिसमें एक नियमित Javadoc टिप्पणी (कोई HTML) नहीं है। उत्तरार्द्ध को प्राथमिकता दी जाती है, क्योंकि यह आपको कुछ अतिरिक्त सुविधाएँ (विशेष रूप से पैकेज एनोटेशन) देता है।
विवरण: जावा के लिए सूर्य के डॉक्स
package-info.java
ठीक-ठाक समर्थन करता है।
package.html
पैकेज स्तर पर एक फ़ाइल के साथ (यानी उस पैकेज के लिए निर्देशिका में)। यह पूरी तरह से गठित होना चाहिएHTML
फ़ाइल , जिसमें <html>
टैग को परिभाषित किया गया है