2011-05-24 5 views
8

मैं अपने javadocs में कस्टम टैग का उपयोग करना चाहता हूं, लेकिन किसी तरह के सम्मेलन से चिपकना चाहता हूं ताकि अन्य लोगों के पास उन्हें समझने में आसान समय हो। ओरेकल के आधिकारिक जावाडोक दस्तावेज़ पृष्ठ पर, उन्होंने मूल टैग सूचीबद्ध किए हैं, जो कि मेरे संपादक के जावाडोक कोड संकेत में दिखाई देने वाले टैग की सूची की तुलना में एक छोटा सेट है।लोकप्रिय जावाडोक टैग के लिए उपयोग करने के लिए एक अच्छा संदर्भ?

क्या कोई अच्छा संदर्भ ऑनलाइन है, जिसमें लोकप्रिय जावाडोक टैग सूचीबद्ध हैं?

उत्तर

9

StackOverflow उपयोगकर्ता Uri है कि वह एक संबंधित question के लिए एक answer रूप javadocs की प्रभावशीलता में अपनी पीएचडी शोध के हिस्से के रूप का प्रस्ताव कस्टम टैग की एक सूची प्रदान की है। आप उनको अपना सकते हैं और कुछ विश्वास कर सकते हैं कि आप कुछ शोध कर रहे हैं जो कुछ शोध द्वारा समर्थित है।

व्यक्तिगत रूप से, मैं केवल मानक जावाडोक टैग के साथ रहूंगा और ओरेकल (सूर्य) How to Write Doc Comments for the Javadoc Tool में उल्लिखित सर्वोत्तम प्रथाओं का पालन करता हूं।

1

नहीं वास्तव में प्रश्न का उत्तर है, लेकिन संबंधित:

कस्टम जावाडोक टैग का उपयोग करने के लिए, आप या तो, (जो किसी भी टैग यह चाहता है समर्थन कर सकते हैं) एक कस्टम doclet उपयोग करने के लिए मानक doclet के साथ कस्टम taglets का उपयोग , या उन टैग को परिभाषित करने के लिए -tag कमांड लाइन पैरामीटर का उपयोग करें। अन्यथा आपको javadoc से चेतावनी मिलेगी (और इस टैग के लिए कोई आउटपुट नहीं)।

तो जब आप पहले से ही किसी ऐसे व्यक्ति के साथ सहयोग कर रहे हैं, तो यह वास्तव में कस्टम टैग का उपयोग करने के लिए समझ में आता है, और यह कोई आपको बताएगा कि आपको किस जावाडोक विकल्प का उपयोग करना है। (या आप स्वयं इन विकल्पों को जोड़ते हैं)।

मैं किसी भी गैर मानक टैग का उपयोग नहीं करता, मानक मेरे लिए पर्याप्त हैं।

0

मैं जावाडोक टैग के उदाहरण के लिए इस link पता चला

 संबंधित मुद्दे

  • कोई संबंधित समस्या नहीं^_^