मेरे पास जावाडोक के बिना एक बड़ा कोडबेस है, और मैं बुनियादी जावावाक जानकारी (उदाहरण के लिए, प्रत्येक विधि के पैरामीटर लिखने के लिए @param ...) के साथ एक कंकाल लिखने के लिए एक प्रोग्राम चलाने के लिए चाहता हूं, इसलिए मुझे बस अंतराल को भरें।जावाडोक टेम्पलेट जनरेटर
कोई भी इसके लिए एक अच्छा समाधान जानता है?
संपादित करें:
JAutodoc मैं के लिए क्या देख रहा था। इसमें चींटी कार्य, एक ग्रहण प्लगइन है, और टेम्पलेट परिभाषा के लिए वेग का उपयोग करता है।
JAutodoc प्लगइन वास्तव में आप क्या जरूरत है, लेकिन एक पैकेज विस्तृत रूप से देख:
सही एक पैकेज पर क्लिक करें, "सदस्यों के लिए जावाडोक जोड़ें ..." और कंकाल जोड़ दिया जाएगा।
कई दिलचस्प विकल्प होते हैं: जावाडोक के लिए टेम्पलेट्स, हर फ़ाइल के शीर्षक में एक TODO जोड़ने कह रही: "टेम्पलेट जावाडोक, भरा होना चाहिए ...", आदि
यदि आप एक्लिप्स में फ़ाइल के स्रोत में राइट-क्लिक करते हैं, तो इसमें स्रोत मेनू के तहत एक जावाडॉक पीढ़ी विकल्प है। ग्रहण के लिए
आप चेतावनी दिखाने के लिए ग्रहण कॉन्फ़िगर कर सकते हैं उन चीज़ों के लिए जिनके पास जावाडोक की कमी है, या जवाडोक है जिसमें सभी जानकारी नहीं है, या गलत जानकारी है। यह आपके लिए भरने के लिए टेम्पलेट भी सम्मिलित कर सकता है।
आपके द्वारा मांगा जाने वाला टूल नहीं है, लेकिन शायद बेहतर है क्योंकि आप खाली तरीके से खाली कंकाल के साथ समाप्त नहीं होंगे।
आप अपने कार्यक्षेत्र के लिए विंडो> प्राथमिकताएं> जावा> कंपाइलर> जावाडोक पथ से परे वरीयता पृष्ठ की जांच और संपादन करके इसे प्राप्त कर सकते हैं। कि वरीयता पृष्ठ का स्क्रीनशॉट नीचे है:
इस स्क्रीन में आइटम के बारे में अधिक जानकारी के लिए नीचे दिए गए लिंक का पालन करें:
मुझे लगता है कि स्वचालित रूप जेनरेट खाली जावाडोक है एक विरोधी पैटर्न और निराश होना चाहिए; यह कोड को दस्तावेज होने की उपस्थिति देता है, लेकिन कोडबेस में शोर जोड़ता है।
मैं इसके बजाय अनुशंसा करता हूं कि जब आप वास्तव में जावाडोक लिखते हैं तो एक प्रति विधि और प्रति-वर्ग आधार पर सहायता के लिए आप अपना कोड संपादक कॉन्फ़िगर करते हैं (एक टिप्पणीकर्ता ग्रहण की सुविधा को इंगित करता है)।
क्या आप बता सकते हैं कि प्रति-विधि, प्रति-वर्ग आधार पर कुछ कैसे सेट अप किया गया है जैसा आपने बताया है? – trusktr
लोग यहां इंगित करते हैं कि यह एक fea है ग्रहण का इलाज मैं vim का उपयोग कर कोड (एड) जावा, जो काफी विन्यास योग्य है-आप बस एक मैक्रो बनाते हैं कि, जब किसी विधि या वर्ग के नाम पर, जावाडोक बॉयलरप्लेट को भरने के लिए जोड़ता है। ईमानदारी से, हालांकि, स्लैश और तारांकन टाइप करना नहीं है वास्तव में अच्छी प्रलेखन लिखने की बाधा – davetron5000
तुम भी एक तरीका है आप JavaDoc चाहते हैं इसके बाद के संस्करण लाइन पर अपना कर्सर ले सकता है, तो टाइप करें:
/**
और Enter दबाएं। यह आपके जावाडॉक स्टब उत्पन्न करेगा।
Alt + Shift + J –
मैक पर, यह ⌘-alt-J है –
विधि का चयन करें कि आप जावाडोक और alt + शिफ्ट + जे जोड़ना चाहते हैं, स्वचालित रूप से जावाडोक टिप्पणी पैदा करता है।
उदाहरण:
/**
* @param currDate
* @param index
* @return
*/
public static String getAtoBinary(String currDate, int index){
String HourA = "0";
try{
String[] mydate = currDate.split("/");
HourA = mydate[index].substring(1, 2);
}catch(Exception e){
Log.e(TAG, e.getMessage());
}
return HourA;
}
मैंने इस प्लग-इन के दस्तावेज़ को पढ़ा है। यह आपके विधियों, चर, पैरामीटर इत्यादि में जावाडॉक टिप्पणियां जोड़ने के लिए बहुत ही स्वचालित तरीके प्रदान करता है लेकिन यदि आप ऑटो-जेनरेट की गई टिप्पणियों को संपादित करने के लिए उन्हें " सबसे अच्छा स्पष्टीकरण ", यह आपके कोड में बहुत सारे लाइन शोर से अधिक नहीं है ... – Taner