2009-10-02 1 views
21

मुझे अपना ईमेल पता @author टैग के भीतर डालना पसंद है और चाहते हैं कि वे उत्पन्न जेवाडोक में mailto: लिंक क्लिक करने योग्य हों।जावाडोक के भीतर एक ईमेल शामिल करने का सही तरीका क्या है?

मुझे यह सही तरीके से करने के लिए कैसे जाना चाहिए?

/** 
* I currently do the following, but would like to have my name 
* displayed as the link rather than the email itself. 
* 
* @author {@link "mailto:[email protected]"} 
*/ 
public class Useless { } 

/** 
* I've tried this, but get warnings about unexpexted text where my name is. 
* 
* @author {@link "mailto:[email protected]" "Benoit St-Pierre"} 
*/ 
public class Useless { } 

उत्तर

31

{@link} जावाडोक विशिष्ट मार्कअप है। हालांकि, जावाडॉक्स एचटीएमएल हैं - इसलिए आप आसानी से

/** 
* Embed HTML directly into the Javadoc. 
* 
* @author <a href="mailto:[email protected]">Benoit St-Pierre</a> 
*/ 
public class Useless { } 

चाहे यह एक अच्छा विचार हो या नहीं, एक अलग मामला है। :-)

+12

मैं व्यक्तिगत रूप से '@Author मेरा पूरा नाम ' का उपयोग करूंगा। यद्यपि संभवतः ई-मेल भाग को HTML टैग के रूप में सोचा जाने से बचने के लिए बचने की आवश्यकता है। मुझे अभी भी जावाडॉक में एचटीएमएल के करीबी संबंध बहुत ही दुर्भाग्यपूर्ण निर्णय मिलते हैं :-( – Joey

+2

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

+4

+1 इसके अलावा जावाडोक सम्मेलन आर्थिक रूप से इन-लाइन लिंक के उपयोग की सिफारिश करता है। {@link} को संदर्भित कक्षा के निर्दिष्ट पैकेज, वर्ग या सदस्य नाम के लिए प्रलेखन को इंगित करने के लिए उपयोग किया जाना चाहिए, ई-मेल या यूआरएल से लिंक न करें (यूआरएल के लिए आपको @see का उपयोग करना चाहिए) – JuanZe