2009-07-22 13 views
17

मेरी प्रोजेक्ट में, हम कई एनोटेशन का उपयोग करते हैं जो जावाडोक एपीआई दस्तावेज में देखने के लिए बहुत उपयोगी होंगे।क्या एनोटेशन दस्तावेज करने के लिए जावाडोक टूल प्राप्त करने का कोई तरीका है?

किसी को भी उत्पन्न javadocs में एनोटेशन शामिल करने के लिए एक आसान तरीका पता है? मैं अपना खुद का जावाडोक प्लगइन नहीं लिखना चाहता हूं। क्या वहां कोई समाधान है?

उत्तर

25

java.lang.annotation.Documented

इंगित करता है कि एक प्रकार के साथ एनोटेशन डिफ़ॉल्ट रूप से जावाडोक और इसी तरह के उपकरणों के द्वारा प्रलेखित किया जाना हैं देखें। इस प्रकार का उन प्रकारों की घोषणाओं को एनोटेट करने के लिए उपयोग किया जाना चाहिए जिनकी टिप्पणियां अपने ग्राहकों द्वारा एनोटेटेड तत्वों के उपयोग को प्रभावित करती हैं। यदि दस्तावेज के साथ एक प्रकार की घोषणा की गई है, तो इसकी टिप्पणियां एनोटेटेड तत्वों के सार्वजनिक एपीआई का हिस्सा बन जाती हैं।

उदाहरण:

import java.lang.annotation.Documented; 

@Documented 
public @interface MyAnnotation { 
} 
संबंधित मुद्दे

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