मैं जावा में पैकेज कैसे दस्तावेज कर सकता हूं?


182

जावा एपीआई में मैं संकुल के लिए Javadoc टिप्पणियाँ देख सकता हूँ।

पैकेज को दस्तावेजित करने के लिए मैं जावदॉक की टिप्पणियों को कैसे / कहां रखूं?

जवाबों:


257

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

संकुल के लिए भाषा विनिर्देशन


3
विशेष लिंक के लिए लिंक: docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1
gavenkoa

7
intellij में आप एक पैकेज पर राइट क्लिक कर सकते हैं और इसे बनाने का विकल्प नई फ़ाइल मेनू के अंतर्गत होना चाहिए
bsautner

मुझे फ़ाइल को packagename / src / packagename (बाकी स्रोत फ़ाइलों के साथ) में होना आवश्यक है
trindflo

48

जावा 1.4 तक और इसमें शामिल, आपको एक HTML फ़ाइल package.html प्रदान करनी थी, जैसा कि अन्य उत्तरों में वर्णित है।

Java 1.5 के बाद से आप एक भी प्रदान कर सकते हैं package-info.java, जिसमें एक नियमित Javadoc टिप्पणी (कोई HTML) नहीं है। उत्तरार्द्ध को प्राथमिकता दी जाती है, क्योंकि यह आपको कुछ अतिरिक्त सुविधाएँ (विशेष रूप से पैकेज एनोटेशन) देता है।

विवरण: जावा के लिए सूर्य के डॉक्स


2
दोनों तरीकों का उल्लेख करने के लिए +1, और उनके बीच आवश्यक अंतर। वैसे, कम से कम IntelliJ IDEA के पास फिलहाल पैकेज.html के लिए बेहतर समर्थन है (पैकेज के नाम पर Ctrl-Q पैकेज Javasocs दिखाता है)।
जोनीक

3
मेरी पिछली टिप्पणी पर अपडेट करें: आजकल आईडिया package-info.javaठीक-ठाक समर्थन करता है।
जोनिक

4

package.htmlपैकेज स्तर पर एक फ़ाइल के साथ (यानी उस पैकेज के लिए निर्देशिका में)। यह पूरी तरह से गठित होना चाहिएHTML फ़ाइल , जिसमें <html>टैग को परिभाषित किया गया है


1
अधिक जानकारी? फ़ाइल कैसी दिखनी चाहिए?
jjnguy

1
यह एक HTML फ़ाइल है जिसमें आपके पैकेज का विवरण है। बस!
oxbow_lakes

3
यह इसे करने का पुराना तरीका है। जावा 1.5 के बाद से आप
पैकेज-info.java
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.