निजी तरीकों के लिए जावाडॉक (ब्लूजे)

Question

मैं ब्लूजे का उपयोग कर रहा हूं और मैं अपनी पूरी परियोजना के जावाडोक उत्पन्न करना चाहता हूं। मैं जावाडोक पर निजी तरीकों को दिखाना चाहता हूं, क्या ऐसा करने का कोई तरीका है? ब्लूजे में एक उपकरण है जो जावाडोक बनाता है, लेकिन ब्लूजे निजी तरीकों को अनदेखा करता है। सिर्फ एक सम्मेलन है? यदि यह एक सम्मेलन है, तो मुझे समझ में नहीं आता है कि वे "आंतरिक" विधियों को क्यों नजरअंदाज करते हैं, वे भी उपयोगी होते हैं-.- *

Answer 1

This link बताता है कि ब्लूजे केवल सार्वजनिक विधियों और कक्षाओं के लिए जावाडॉक्स उत्पन्न करेगा। विशेष रूप से:

अपने उत्पादन केवल सार्वजनिक तरीकों और चर

हालांकि बारे में जानकारी होगी इस bug reportAndrew Thompson's answer में से जुड़ा हुआ के अनुसार, ऐसा लगता है इस BlueJ के संस्करण 1.1.5 में तय किया गया है । वास्तव में, BlueJ Reference Manual की धारा 9.8 के अनुसार, आप बिल्कुल निर्दिष्ट कर सकते हैं doctool.options संपत्ति संपादित करके JavaDoc टूल चलाते समय उपयोग करने के लिए कौन से विकल्प उपयोग करें।

• doctool.command:

  इसमें 3 गुण है कि प्रलेखन पीढ़ी के व्यवहार को नियंत्रित प्रतीत नियंत्रण क्या आदेश प्रलेखन उत्पन्न करने के लिए प्रयोग किया जाता है, और डिफ़ॉल्ट रूप से javadoc

• doctool.outputdir पर सेट है: नियंत्रण जहां उत्पन्न प्रलेखन सहेजा गया है, और डिफ़ॉल्ट रूप से doc
• doctool.options पर सेट किया गया है: javadoc.command द्वारा निर्दिष्ट कमांड को पास किए गए अन्य कमांड लाइन विकल्पों को नियंत्रित करता है, और डिफ़ॉल्ट रूप से सेट किया जाता है -author –version –nodeprecated –package पर। ध्यान दें, -package को -private के साथ बदलकर आप सभी विधियों को दस्तावेज कर सकते हैं।

सामान्य तौर पर, के बाद से JavaDoc उपकरण एक कमांड लाइन कार्यक्रम है, तो आप बस इसे अपने कमांड लाइन से कुछ इस तरह के साथ कॉल कर सकते हैं:

$ javadoc -d \path\to\output\folder -sourcepath \path\to\source\folder -private 

ध्यान दें, इस आदेश मानता है कि javadoc है आपके पाथ पर्यावरण चर में शामिल है, जो आम तौर पर अधिकांश जावा इंस्टॉलेशन में होता है।

• -d विकल्प वांछित आउटपुट निर्देशिका देता
• -sourcepath विकल्प JavaDoc उपकरण जहां
• -private विकल्प JavaDoc उपकरण बताता सभी वर्गों के लिए प्रलेखन बनाने के लिए, सदस्यों दस्तावेज़ के लिए स्रोत कोड को खोजने के लिए कहता है , और तरीकों

विकल्प है कि सदस्यों को नियंत्रित कि JavaDoc दस्तावेज़ होगा की पूरी सूची (निजी रूप में सबसे प्रतिबंधित दृश्यता है):

01,235,

• -public - केवल सार्वजनिक कक्षाएं और सदस्यों को दिखाता है।
• -protected - केवल संरक्षित और सार्वजनिक कक्षाएं और सदस्यों को दिखाता है। यह डिफ़ॉल्ट है।
• -package - केवल पैकेज, संरक्षित, और सार्वजनिक वर्ग और सदस्यों को दिखाता है।
• -private - सभी वर्गों और सदस्यों को दिखाता है।

संपादित करें (JavaDoc Documentation से लिया) 0: अपडेट किया गया जवाब स्वीकार किए जाते हैं जवाब में लिंक द्वारा Andrew Thompson

Answer 2

आम तौर पर सम्मेलन द्वारा लोगों ने जावाडोक में निजी तरीकों को नहीं रखा क्योंकि जावडोक किसी के लिए होना है अपना कोड खपत चूंकि वे निजी तरीकों तक नहीं पहुंच सकते हैं, इसलिए उन दर्शकों के लिए उन्हें दस्तावेज करने में कोई समझ नहीं है।

javadoc -private 

अपने जावाडोक में निजी तरीकों उत्पन्न करेगा:

हालांकि, जावाडोक उपकरण इस सक्षम करने के लिए एक ध्वज है। मुझे यकीन नहीं है कि ब्लूजे इस के साथ कैसे काम करता है, लेकिन शायद आप ध्वज या कुछ में गुजर सकते हैं।

Answer 3

प्रकाश में लाया नई जानकारी शामिल करने के लिए एक लेख लिखा से है 2001 में। तब से बहुत कुछ बदल गया है।

ईजी। 'Bluej + javadocs' के शीर्ष 5 या तो लिंक के माध्यम से शिकार करना कुछ ऐसा लिंक है जो बग रिपोर्ट का उल्लेख allow inclusion of private methods in javadoc पर करता है। विवरण का उल्लेख है:

मेकअप जावाडोक मापदंडों उपयोगकर्ता definable (bluej.defs में) ताकि उपयोगकर्ताओं को विकल्प के लिए है प्रलेखन

में निजी तरीकों में शामिल करने के लिए है भी कहा गया है:

Resolution:  FIXED 

---

नोट: मैं ब्लूजे का उपयोग नहीं करता हूं, लेकिन मुझे एक अविश्वसनीय उत्तर सुना जब एक प्रमुख आईडीई में इतनी सरलता की कॉन्फ़िगरेशन करने की कोई क्षमता नहीं है ई बात