151
जावा एपीआई में मैं संकुल के लिए जावाडोक टिप्पणियां देख सकता हूं।मैं जावा में संकुल दस्तावेज़ कैसे करूं?
पैकेज को दस्तावेज करने के लिए मैं जावडोक टिप्पणियां कैसे/कहां रखूं?
A
उत्तर
214
1,5 के रूप में आप एक package-info.java फ़ाइल को परिभाषित करने और एक पैकेज के लिए एक मानक जावाडोक शैली टिप्पणी प्रदान कर सकते हैं:
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
3
पैकेज स्तर पर package.html फ़ाइल के साथ (यानी उस पैकेज के लिए निर्देशिका में)। <html> टैग में <html> टैग के साथ यह पूरी तरह से गठित टैग होना चाहिए, जिसमें
38
जावा 1.4 तक, आपको अन्य उत्तरों में वर्णित एक HTML फ़ाइल package.html प्रदान करना था।
जावा 1.5 के बाद से आप package-info.java भी प्रदान कर सकते हैं, जिसमें एक नियमित जावाडोक टिप्पणी (कोई HTML नहीं) है। उत्तरार्द्ध को प्राथमिकता दी जाती है, क्योंकि यह आपको कुछ अतिरिक्त सुविधाएं देता है (विशेष रूप से पैकेज एनोटेशन)।
विवरण: Sun's docs for javadoc
spec के लिए सीधा लिंक: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa
इंटेलिज में आप एक पैकेज और विकल्प पर राइट क्लिक कर सकते हैं इसे बनाने के लिए नए फ़ाइल मेनू के तहत होना चाहिए – bsautner