2012-08-01 12 views
11

मैं चाहता हूं कि जब मैं एक विधि पर माउस करता हूं तो मैं अपने दस्तावेज़ को देख सकता हूं कि जब मैं माउस को जावा की विधि पर माउस डालता हूं तो मुझे पता है कि/** */यह कैसे किया गया है, लेकिन:जावा डॉक्स जैसे जावा में मेरी विधि को कैसे दस्तावेज़ित करें?

  1. आप कैसे समझाते हैं कि परम किसके लिए खड़ा है?

  2. आप एक नई लाइन कैसे बनाते हैं, या शब्द बोल्ड या इटैलिक बनाते हैं?

+4

के लिए कृपया (http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html) – pb2q

उत्तर

19

आप ग्रहण उपयोग कर रहे हैं आईडीई के रूप में, तुम बस के साथ एक टिप्पणी बनाने की जरूरत

/** 

और एंटर दबाएं और यह पैरामीटर, रिटर्न वैल्यू इत्यादि सहित आपके जावाडोक के लिए आपका कोड जेनरेट करेगा। आपको केवल विवरण डालना होगा।

एक ही कक्षा घोषणाओं (जावाडोक टिप्पणी हमेशा निम्न तत्व से संबंधित है) के लिए लागू होता है

नोट:

अपने विधि करने के लिए दस्तावेज़ संलग्न करने के लिए आप शीर्ष पर टिप्पणी में विधि नाम निर्दिष्ट करना होगा ।

उदाहरण

/** 
* create_instance 
* @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
* respectively. 
* @return Instance object 
*/ 
+0

अच्छा पढ़ा [डॉक्स]! !!!!!!!!!!!! –

+0

डीड में, अक्सर फ़ीचर –

+0

का उपयोग किया जाता है आप intelliJ – Simon

22

आप क्या पैरामीटर से होता है कैसे की व्याख्या करते हैं?

उपयोग @param टैग:

/** 
* @param paramName Explanation of the param 
*/ 
public void foo(String paramName); 

कैसे आप एक नई लाइन बनाने के लिए, या एक शब्द बोल्ड या इटैलिक कर सकता हूँ?

उपयोग मानक HTML, यानी <p></p>, <br/>, <strong> और <em> (या कम अर्थ <b> और <i>)