स्वचालित रूप से Javadoc को अद्यतन करने के लिए कोई उपकरण हैं?

Question

मैं एक कोड बेस पर काम करता हूं जो ... गन्दा है। इस गड़बड़ी का एक पहलू यह है कि हमारे पास विधियों का एक टन है जिसका हस्ताक्षर अब संबंधित जावाडोक से मेल नहीं खाता है। उदाहरण के लिए:

/** 
* 
* @ param foo 
*/ 
public void doFoo(int bar) {... 

मैं उत्पन्न जावाडोक का कोई प्रशंसक हूँ (यह हमेशा बेकार लगभग के रूप में), लेकिन मैं वास्तव में एक उपकरण है कि हमारे कोड के माध्यम से जाना होगा इस्तेमाल कर सकते हैं, इस तरह के मामलों मिल जाए, और:

1. "foo" परम
2. "बार" परम (लेकिन सिर्फ एक खाली एक, कोई स्वत: जनरेट दस्तावेज़ या कुछ भी)

इस तरह के एक उपकरण मौजूद है के लिए जावाडोक जोड़ने के लिए जावाडोक निकालना चाहते हैं? यदि नहीं, तो क्या कोई उपकरण है जो # 1 मौजूद है? यहां तक ​​कि हमारे निर्माण में हमें कचरा चेतावनियों की मात्रा में काफी कमी आएगी। धन्यवाद।

Answer 1

नेटबीन के लिए एक उपकरण है। यह वही करता है जो आप पूछते हैं।

आप या तो ऊपर, या एक फ़ाइल पर राइट क्लिक करके Tools मेनू पर क्लिक कर सकते हैं, तो Analyze Javadocs और Tools, तो Analyze Javadocs क्लिक करें।

यह आपको इसे ठीक करने के विकल्प के साथ अपने जावाडॉक्स के साथ पाई जाने वाली सभी समस्याओं की एक सूची देता है। यह आपको किसी विधि में एक समस्या को ठीक करने की अनुमति देता है, फ़ाइल के लिए, पैकेज के लिए, या पूरे प्रोजेक्ट के लिए विधि के लिए javadocs को ठीक करता है।

Answer 2

यदि आप ग्रहण का उपयोग कर रहे हैं, तो एक समाधान, Window -> Preferences -> Java -> Compiler -> Javadoc पर जाना है और फिर चेतावनी या त्रुटि के लिए 'मालफॉर्मेड जावाडोक टिप्पणियां' चर सेट करें।

आप समस्याओं को Window -> Show View -> Problems पर देख सकते हैं और फिर प्रत्येक त्रुटि पर राइट क्लिक करें और 'त्वरित फिक्स' चुनें।

Answer 3

मैंने डॉक चेक के अलावा इनमें से किसी भी कोशिश की नहीं है, लेकिन this somewhat-dated page on Sun's site कई तृतीय-पक्ष दस्तावेज़ों को सूचीबद्ध करता है, जिनमें से कुछ आपके स्रोत में जावाडोक डालने का अधिकार रखते हैं। उनमें से, आप Doc-o-Matic, JRefactory Pretty Printer, और ACTOS Auto Commentator for Java पर एक नज़र डाल सकते हैं। दोबारा, मैंने इनमें से किसी भी कोशिश नहीं की है, लेकिन यह शुरू करने के लिए एक जगह है।