एंड्रॉइड स्टूडियो में javadoc टिप्पणियां कैसे उत्पन्न करें


204

क्या मैं एंड्रॉइड स्टूडियो में javadoc टिप्पणियों को उत्पन्न करने के लिए शॉर्टकट कुंजियों का उपयोग कर सकता हूं?

यदि नहीं, तो javadoc टिप्पणियों को उत्पन्न करने का सबसे आसान तरीका क्या है?


यह प्रश्न 50/50 है। आप पूरे दस्तावेज़ में javadoc उत्पन्न करने के एकल javadoc ब्लॉक की तलाश में हैं। यह किसका है?
के - एसओ में विषाक्तता बढ़ रही है।

ALTR + ENTER वह दृश्य दिखाएं जो आप पहले से घोषित विधियों की टिप्पणी से उत्पन्न कर सकते हैं।
ज़ला जनकसिंह

हो सकता है कि आपको इसके लिए एक लाइव टेम्पलेट (एंड्रॉइड स्टूडियो - सेटिंग - एडिटर - लाइव टेम्प्लेट - ऐड) जोड़ना चाहिए। टेम्प्लेट टेक्स्ट फ़ील्ड में निम्न टेक्स्ट जोड़ें। / ** * $ टिप्पणी $ * /
जॉनेट मैथ्यू

जवाबों:


388

मुझे javadoc टिप्पणी उत्पन्न करने के लिए कोई शॉर्टकट नहीं मिल रहा है। लेकिन अगर आप /**विधि घोषणा से पहले टाइप करते हैं और Enter दबाते हैं, तो javadoc कमेंट ब्लॉक अपने आप जेनरेट हो जाएगा।

अधिक जानकारी के लिए इसे पढ़ें ।


7
यह शर्म की बात है कि यह कक्षाओं, फ़ील्ड्स, आदि के लिए javadoc टिप्पणियों को उत्पन्न करने के लिए भी काम नहीं करता है, यह भी अच्छा होगा यदि यह अनुकूलन योग्य टेम्पलेट से javadoc उत्पन्न करता है।
टेड होप

23
बेशक इसका शॉर्टकट है: पोजीशन ऑन कंस्ट्रक्शन / कंस्ट्रक्टर का नाम और alt + एंटर दबाएं, मेन्यू से जेवाडॉक चुनें
Ewoks

उपरोक्त समाधान के बारे में इसे और देखें
प्रीतेश विश्वकर्मा

110

टिप्पणी करने के /**लिए विधि घोषणा और प्रेस से पहले कुंजी टाइप करें Enter। यह javadoc टिप्पणी उत्पन्न करेगा।

उदाहरण:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

अधिक जानकारी के लिए लिंक https://www.jetbrains.com/idea/features/javadoc.html देखें


4
@ सत्थेश्वरन - सच में? यह एक उदाहरण के रूप में मिला है, केवल एक ही जवाब दोओ (मूल उत्तर) से है। यहां तक ​​कि लिंक एक प्रति है। उदाहरण को मूल उत्तर में जोड़ा जाना चाहिए था।
CJBS

3
@ सत्थेश्वरन - इसके लायक क्या है, मैं देख सकता हूं कि केवल टिप्पणियों का उदाहरण (उत्तर में) उपयोगी है, जब कोई जल्दी से उत्तर चाहता है; ;-)
CJBS

वास्तव में उदाहरण के पास अंतिम से पहले एक कमी है *
मैक्सिमिलियानो अमृत

35

यहाँ Oracle से JavaDoc टिप्पणी का एक उदाहरण है :

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

मूल प्रारूप निम्नलिखित तरीकों में से किसी एक में स्वतः उत्पन्न किया जा सकता है:

  • कर्सर को विधि के ऊपर रखें और टाइप करें /**+Enter
  • कर्सर को विधि के नाम पर रखें और दबाएँ Alt+ Enter> JavaDoc जोड़ें पर क्लिक करें यहां छवि विवरण दर्ज करें

17

आप सेटिंग्स-> प्लगइन-> ब्राउज़ रिपॉजिटरी से जावाडॉक प्लगइन स्थापित कर सकते हैं।

नीचे दिए गए लिंक से प्लगइन प्रलेखन प्राप्त करें

JavaDoc प्लगइन दस्तावेज़

यहां छवि विवरण दर्ज करें


यह बहुत अच्छा काम करता है। JavaDoc प्लगइन स्थापित करें (ऊपर के रूप में), फिर CNTL + SHIFT + ALT + G. दबाएँ
एलन नेल्सन

10

आप "फिक्स डॉक्टर टिप्पणी" के माध्यम से जावाडोक टिप्पणी पीढ़ी की ग्रहण शैली का उपयोग कर सकते हैं। "वरीयता" -> "कीमैप" खोलें और "कुंजी पर टिप्पणी ठीक करें" क्रिया असाइन करें जो आप चाहते हैं।


9

यहाँ हम कुछ इस तरह से कर सकते हैं। और किसी भी शॉर्टकट का उपयोग करने के बजाय हम क्लास / पैकेज / प्रोजेक्ट स्तर पर "डिफ़ॉल्ट" टिप्पणी लिख सकते हैं। और आवश्यकता के अनुसार संशोधित करें

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

लाभ यह है कि, आप के लिए टिप्पणी ब्लॉक बना सकते हैं all the methods at a time.


9

आपके आईडीई के स्वत: पूर्ण सुविधा का उपयोग करके Javadoc टिप्पणियों को स्वचालित रूप से जोड़ा जा सकता है। एक नमूना Javadoc टिप्पणी उत्पन्न करने के लिए टाइपिंग /**और हिटिंग Enterका प्रयास करें ।

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */

5

एंड्रॉइड स्टूडियो में आपको प्लग इन की आवश्यकता नहीं है। मैक पर केवल एंड्रॉइड स्टूडियो खोलें -> शीर्ष बार में एंड्रॉइड स्टूडियो पर क्लिक करें -> वरीयताएँ पर क्लिक करें -> सूची में फ़ाइल और कोड टेम्प्लेट खोजें -> चयन शामिल हैं -> इसे बनाएँ और आपके सभी प्रोजेक्ट में लगातार बने रहेंगे


2
  • जावा डॉक्स टिप्पणी जोड़ने का दूसरा तरीका प्रेस है: Ctrl + Shift + A >> पॉपअप दिखाएं >> टाइप करें: javadocs जोड़ें >> Enter।

  • Ctrl + शर्ट + A: कमांड लुक-अप (स्वतः पूर्ण आदेश नाम)

यहां छवि विवरण दर्ज करें


2

बस विधि नाम का चयन करें (यानी क्लिक करें), फिर कुंजी कॉम्बो Alt + Enter का उपयोग करें, "JavaDoc जोड़ें" चुनें

यह मानता है कि आपने पहले ही विधि के ऊपर टिप्पणियां नहीं जोड़ी हैं, अन्यथा "Add JavaDoc" विकल्प दिखाई नहीं देगा।


2

एंड्रॉइड स्टूडियो में हमारे पास ऑटो-जनरेट की गई टिप्पणियों के कुछ तरीके हैं:

  • विधि I:

टाइप करके / ** और फिर एंटर दबाकर आप नेक्स्ट कमेंट लाइन जनरेट कर सकते हैं और यह परमेस आदि को ऑटो-जेनरेट करेगा, लेकिन जब आपको नीचे की तरफ इस चेक आउट मेथड II के लिए हॉटकी की आवश्यकता हो।

  • ** विधि II: **

1 - गोटो टॉपमेनू

2 - फाइल> सेटिंग्स

3 - सेटिंग्स से कीमैप चुनें

4 - शीर्ष पर सही खोज पट्टी "फिक्स डॉक्टर" के लिए खोज

5 - परिणामों से "फिक्स डॉक टिप्पणी" चुनें और उस पर डबल-क्लिक करें

6 - डबल क्लिक करने के बाद खोले गए ड्रॉप डाउन में से कीबोर्ड शॉर्टकट चुनें

7 - कीबोर्ड पर शॉर्टकट कीज दबाएं

8 - अपना कोड प्राप्त करें और जहां आप कुछ टिप्पणी जोड़ना चाहते हैं, शॉर्टकट कुंजी दबाएं

9 - आनंद लें!


डॉक्स को जोड़ने का सबसे ठोस तरीका। उदाहरण के लिए, मैंने "" दिया और शॉर्टकट के रूप में दर्ज किया
कोडटॉइल

1

बस कीमैप सेटिंग्स में कीप के ग्रहण संस्करण का चयन करें। एंड्रॉइड स्टूडियो में एक ग्रहण कीमैप को शामिल किया गया है।


0

मुझे यकीन नहीं है कि मैं इस प्रश्न को पूरी तरह से समझता हूं, लेकिन कीबोर्ड की एक सूची में कटौती की जा सकती है - आशा है कि यह मदद करता है!


2
ग्रहण में टिप्पणी जोड़ने के लिए Alt + Shift + j दबाएं, लेकिन AndroidStudio में लेकिन मुझे नहीं पता कि कैसे करना है
qinxianyuzou

यदि मुझे याद है, तो उस शॉर्टकट ने केवल तभी काम किया है जब आपके पास 'jautodoc' प्लगइन स्थापित और सक्षम था।
मैट

0

Android Studio -> प्राथमिकताएं -> संपादक -> इरादे -> जावा -> घोषणा -> "जावा जोड़ें" सक्षम करें

और, बाईं ओर निचले भाग पर लागू करने के तरीके (Ctrl / Cmd + i) का चयन करते समय, आपको JavaDoc को सक्षम करने के लिए चेकबॉक्स को देखना चाहिए।



-5

ALT+ SHIFT+ Gआपकी विधि के लिए स्वतः जेनरेट की गई टिप्पणियां बनाएगा (कर्सर को आपकी विधि की प्रारंभिक स्थिति पर रखें)।


public void hideKeyboard () u को कर्सर को जनता के सामने रखना चाहिए और इसे आज़माना चाहिए या यह जाँचना चाहिए कि u ने आपके स्टूडियो में जावा डॉक स्थापित किया है या नहीं।
दिनेश आईटी

यह मेरे लिए भी काम नहीं कर रहा है। हो सकता है, यह कुछ विशेष कीमैप में काम कर रहा हो। कीमैप को प्राथमिकताएँ> कीमैप में कॉन्फ़िगर किया जा सकता है। या कीमैप को संपादित किया गया है।
ओलिवर क्रांज़
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.