यूनिट टेस्ट के मामलों के लिए जावा डॉक टिप्पणियां लिखना

Question

मेरी राय में, इकाई परीक्षण के मामले स्वयं कोड के लिए एक दस्तावेज के रूप में काम करते हैं। मेरी कंपनी चाहती है कि मैं इकाई परीक्षण मामलों के शीर्ष पर विस्तृत जावा डॉक टिप्पणी लिखूं। क्या ऐसा करना जरूरी है? क्या आप इस तरह की टिप्पणी लिखते हैं?

Comments

परीक्षण कोड को अच्छी तरह से लिखा और पठनीय माना जाता है, परीक्षण कोड में इस तरह की टिप्पणी का प्राथमिक मूल्य इरादे के एक बयान के रूप में है .. जो कोड समीक्षकों के लिए बहुत मूल्यवान हो सकता है, यहां तक ​​कि खुद को एक साल के समय में, जैसा कि यह आपको अनुमति देता है जिस कोड को लिखा गया था, उसे जज वही कर रहे हैं जो उसे करना है, या परीक्षण करना है कि उसे क्या करना है। दूसरे, आप JAVADOC या यहां तक ​​कि एक साधारण स्क्रिप्ट का उपयोग कर सकते हैं कि आपके पास कौन से परीक्षण हैं और वे क्या कर रहे हैं, इस पर त्वरित दस्तावेज बनाने के लिए कोड से परीक्षण के नाम और टिप्पणियों को परिमार्जन करें।

— चक वैन डेर लिंडेन

Answer 1

मैं क्या कर रहा हूँ JAVADOC- टिप्पणी:

• वर्ग, यह दर्शाता है कि कौन सी कक्षा का परीक्षण किया गया है (भले ही यह मुझे स्पष्ट होना चाहिए क्योंकि उस विषय पर सर्वोत्तम अभ्यास से पता चलता है कि परीक्षण मामले का नाम कक्षा + "टेस्ट" या + "टेस्टकैस") के नाम होना चाहिए। यह {@link XXXClass} JAVADOC टिप्पणी का उपयोग करके किया जाता है

• विधियों, यह दर्शाता है कि किस विधि का परीक्षण किया गया है ({@link XXXClass # method1})। कभी-कभी मुझे सभी रास्तों का सही तरीके से परीक्षण करने के लिए एक कक्षा की एक विधि के लिए कई परीक्षण विधियों की आवश्यकता होती है। जब ऐसा होता है, तो मैं एक अतिरिक्त पंक्ति लिखता हूं कि मैं किस पथ का परीक्षण कर रहा हूं (लेकिन मैं अपनी एक पंक्ति के सम्मेलन से कभी नहीं भटका)

इसके अलावा, कोई अन्य टिप्पणी नहीं। उनका ध्यान कहीं और ले जाने के लिए हो सकता है कि आप सुंदर कोड कवरेज ग्राफिक्स उत्पन्न करने और उन्हें इस तरह खुश करने के लिए कोबर्टर जैसे कुछ का उपयोग कर सकते हैं :-)

अतिरिक्त ध्यान दें: मैं यूनिट परीक्षण के मामलों की बात कर रहा हूं, अगर हम एकीकरण परीक्षण के मामलों के बारे में बात कर रहे हैं, तो यह बताने के लिए कि क्या हो रहा है, एक या दो और लाइनें वास्तव में आवश्यक हो सकती हैं ...

Answer 2

इस प्रश्न के उत्तर में किसी भी कोड के लिए दस्तावेज़ीकरण की आवश्यकताएं पूरी तरह से शामिल हैं: मेरा मालिक एक कोडेड लाइन-बाय-लाइन चाहता है।

उत्तर के सारांश के रूप में आप वहां देखेंगे, "यह आपकी स्थिति पर निर्भर करता है"। ऐसे मामले हैं जहां यह उचित (और प्रोत्साहित) है, और अन्य जहां यह आपके समय की बर्बादी है।

Answer 3

Javadoc टिप्पणियों को एक अलग संदर्भ दस्तावेज़ में निकाला और स्वरूपित किया जा सकता है, इकाई परीक्षण नहीं कर सकते हैं। यह भी ध्यान रखें कि आप जो शब्दों में लिखते हैं, वह वास्तविक कोड से भिन्न हो सकता है, और आमतौर पर आप शब्दों में वास्तविक अपेक्षित व्यवहार का वर्णन कर रहे हैं। बग ढूंढने के तरीकों में से एक दस्तावेज की वास्तविक कोड से तुलना करना है, अगर वे मेल नहीं खाते हैं - यह एक बग है (उनमें से किसी में, और कभी-कभी - दोनों)।

इकाई परीक्षण परीक्षण के लिए है, दस्तावेज के लिए नहीं। प्रलेखन के रूप में इकाई परीक्षण का उपयोग करना गलत है और ऐसा नहीं किया जाना चाहिए।

Comments

मुझे दस्तावेज़ों के कोड में काफी मददगार यूनिट परीक्षणों का एक अच्छा सूट मिल गया है। वे इस बात पर एक संदर्भ कार्यान्वयन प्रदान करते हैं कि किसी के कोड का उपयोग कैसे किया जाना चाहिए , इस प्रमाण के साथ कि कोड उस तरह से उपयोग किए जाने पर ठीक से व्यवहार करता है।

— बिल माइकेल

@ बिल - उस पर कोई तर्क नहीं, इसके सहायक। यह उचित प्रलेखन को प्रतिस्थापित नहीं करता है ।

— littleadv

आपके दस्तावेज़ के लिए दर्शकों पर निर्भर करता है - लेकिन कुछ मामलों में आप निश्चित रूप से सही हैं।

— बिल माइकेल

आदर्श रूप से इकाई परीक्षण एक प्रणाली का एकमात्र दस्तावेज नहीं होना चाहिए - लेकिन वास्तविक दुनिया में, 10 में से 9 परियोजनाएं विरासत कोड के साथ काम कर रही हैं जहां इसे किसी भी दस्तावेज के लिए भाग्यशाली माना जा सकता है । और इस मामले में, मैं दस्तावेजों के एक समूह पर इकाई परीक्षण चलाने और पास करने का एक अच्छा सेट पसंद करता हूं जो वास्तविक कोड के साथ पूरी तरह से सिंक से बाहर हो सकता है। (हाँ, यहां तक ​​कि जवादोक भी कर सकते हैं।)

— पेटर तोर्क

@ PéterTörök हाँ ... मैं कई अलग-अलग नियोक्ताओं, कुछ बहुत अच्छी तरह से ज्ञात कंपनियों के बीच चला गया। बहुत सारी विरासत कोड। एकमात्र यूनिट कभी परीक्षण करती है - जो मैंने लिखी थी। इसलिए आप बहुत भाग्यशाली थे। यह मत समझो कि तुमने जो देखा वह सब जगह होता है। और भले ही आपके पास यूनिट परीक्षणों का एक सेट हो ... किसने कहा कि वे सही हैं? किसने कहा कि वे कवर करें कि उन्हें क्या करना चाहिए? किसने कहा कि अपेक्षित परिणाम क्या हैं? आप यह क्यों मानते हैं कि यूनिट परीक्षण सिंक से बाहर नहीं हैं? सिर्फ इसलिए कि वे "पास" हैं? बकवास।

— littleadv