211
पैकेज स्तर Javadoc टिप्पणियां बनाने का प्रयास करते समय, पसंदीदा विधि क्या है? आप क्या करते हैं?जावाडोक: package.html या package-info.java
package-info.java
- पेशेवरों
- नई
- विपक्ष
- एक वर्ग का दुरुपयोग - क्लासेस, कोड के लिए ही हैं टिप्पणी के लिए नहीं
package.html
- पेशेवरों
- एचटीएमएल विस्तार इसकी नहीं कोड आईडीई के/पाठ संपादक
- विपक्ष में
- सिंटेक्स हाइलाइटिंग का मतलब
- कोई नहीं?
मेरे लिए, मैं हमेशा Package.html का उपयोग किया है। लेकिन मैं सोच रहा हूं कि क्या यह सही विकल्प है।
'package-info.java' में [पैकेज] एनोटेशन हो सकते हैं - यह आवश्यक नहीं है कि सभी एपीआई दस्तावेज़ हों। –
मैं कक्षा के दुरुपयोग के रूप में package-info.java को अर्हता प्राप्त नहीं करूंगा। यह एक जावा स्रोत फ़ाइल है (इसमें ".java" फ़ाइल एक्सटेंशन है) लेकिन क्लास फ़ाइल नहीं है क्योंकि इसमें कक्षा घोषणा नहीं है। और, वास्तव में, इसमें कक्षा घोषणा नहीं हो सकती क्योंकि "पैकेज-जानकारी" कानूनी वर्ग का नाम नहीं है। – Scrubbie
पैकेज.html के बजाय package-info.java का उपयोग करने का एक और कारण यह हो सकता है कि .java दस्तावेज़ीकरण का एक विशिष्ट आउटपुट प्रारूप नहीं दर्शाता है। उदाहरण के लिए आप जावाडोक को लाटेक्स या पीडीएफ फाइल के रूप में आउटपुट करना चाहते हैं। जावाडोक कंपाइलर कार्यान्वयन के आधार पर यह .html मामले में समस्याएं पैदा कर सकता है। – honeyp0t