के साथ कवरेज मैं एक परियोजना में शामिल हूं जिसमें सार्वजनिक एपीआई दस्तावेज एक स्पष्ट वितरण योग्य है। यह सुनिश्चित करने के लिए कि रिलीज इस आवश्यकता को पूरा करता है, मैं यह सुनिश्चित करना चाहता हूं कि मेरे एंट बिल्ड फ़ाइल में रिलीज़ लक्ष्य विफल हो जाए यदि दस्तावेज़ कवरेज बहुत कम है।मापना दस्तावेज़ीकरण Javadoc और Ant
न्यूनतम के रूप में, सार्वजनिक या संरक्षित पहुंच वाले प्रत्येक पहचानकर्ता के पास उचित जावाडोक टैग और विवरण होना चाहिए। उदाहरण के लिए, प्रत्येक पैरामीटर के लिए सार्वजनिक विधियों में @param टैग होना चाहिए, @return टैग अगर वापसी का प्रकार void नहीं है, प्रत्येक अपवाद के लिए @throws टैग, और एक पंक्ति विवरण।
वर्तमान में मेरे पास कोबर्टुरा का उपयोग करके जुनीट कोड कवरेज रिपोर्ट और विफलता की स्थिति है, इसलिए दस्तावेज़ीकरण के लिए ऐसा कुछ भी सही होगा। हालांकि, अगर विफलता की स्थिति का पता लगाना उपलब्ध नहीं है, तो एक रिपोर्ट एक उचित विकल्प होगी।
प्रलेखन जवाडोक प्रारूप में होना चाहिए। Doxygen सहित कोई अन्य प्रारूप - स्वीकार्य है।
मैंने ऐसा क्यों नहीं सोचा? बहुत बहुत धन्यवाद! –