युक्ति: Microsoft CodeContracts के साथ ReSharper का उपयोग करना

मैंने कुछ घंटों की कार्यवाही के बाद एक छोटा नोट लिखने का फैसला किया - जवाब अभी ऑनलाइन नहीं, टुकड़ों में और अंग्रेजी में हैं।

Habré पर Microsoft CodeContracts के बारे में पहले से ही लिखा है , यह विजुअल स्टूडियो के लिए एक पुस्तकालय और टूलकिट है, जो सी # में "अनुबंध प्रोग्रामिंग" के तत्वों का उपयोग करने की अनुमति देता है।

हमने अपनी परियोजनाओं में अपेक्षाकृत हाल ही में कोडक्रेक्ट्स (इसके बाद केवल "अनुबंध" के रूप में संदर्भित) का उपयोग करना शुरू कर दिया, और, सामान्य रूप से, संतुष्ट हैं, हालांकि हमें संकलन समय की प्रतीक्षा करने के लिए कुछ सेकंड मिले हैं।

खैर, और, ज़ाहिर है, हम ReSharper का उपयोग करते हैं, जिसे अतिरिक्त परिचय की आवश्यकता नहीं है।

लेकिन इस तथ्य में कुछ बारीकियां हैं कि प्रभावी ढंग से काम करने के लिए, इन दो उपकरणों को थोड़ा दोस्त बनाने की आवश्यकता है।

परमाणु 1. विधि आह्वान छोड़ दिया जाता है

सबसे पहले, आप देखेंगे कि डिफ़ॉल्ट रूप से ReSharper को लगता है कि अनुबंध की तरह कुछ कॉलों को विधानसभा से बाहर रखा जाएगा, और निर्दयता से उन्हें "कूड़े":



वास्तव में, इन कॉलों को विधानसभा से बाहर नहीं रखा गया है। अनुबंध की कुछ विधियाँ, जैसे कि Contract.Requires और Contract.Ensures , [Conditional("CONTRACTS_FULL")] विशेषता के साथ चिह्नित हैं, लेकिन CONTRACTS_FULL ध्वज को संकलन से पहले अनुबंध तंत्र द्वारा सेट किया गया है, पहले से ही प्रोजेक्ट के बिल्ड स्टेज पर है, और इसलिए ReSharper के संपादन चरण में दिखाई नहीं देता है) यह सेटिंग्स में पूर्वनिर्धारित संकलन पात्रों की सूची को देखता है।

सामान्य संकलन के बाद, कॉन्ट्रैक्ट मैकेनिज्म परिणामी आईएल-कोड __ConstractRuntime , और इन कॉल्स को __ConstractRuntime क्लास से दूसरों के साथ बदल देता है। आप इसे आसानी से रिफ्लेक्टर के साथ और अधिक विस्तार से देख सकते हैं (जल्दी करो जबकि यह अभी भी मुक्त है)।

लेकिन Contract.Assert को कॉल बहुत शुरुआत से कोड में मौजूद हैं, और वे बिना किसी पुनर्लेखन के रनटाइम पर काम करते हैं। उन्हें न केवल [Conditional("CONTRACTS_FULL")] , बल्कि Conditional("DEBUG") रूप में चिह्नित किया गया है। परिणामस्वरूप, डिबगिंग कॉन्फ़िगरेशन (जहां DEBUG प्रतीक परिभाषित किया गया है) के लिए, ReSharper स्वयं समझता है कि यह कॉल वास्तविक है।

तो आप ReSharper को कैसे समझाते हैं कि Contract.Requires भी एक "ईमानदार" कॉल है और इसे संपादक में "गड़बड़" नहीं किया जाना चाहिए? आपको प्रोजेक्ट कॉन्फ़िगरेशन के लिए बिल्ड टैब पर सशर्त संकलन प्रतीक CONSTRACTS_FULL सेट करने की आवश्यकता है जिसमें आपके पास रनटाइम कॉन्ट्रैक्ट चेक चालू है (प्रोजेक्ट विकल्प कोड> रनटाइम चेकिंग)।

लापता तरीकों को तुरंत "देख" होगा! बेशक, एक टैब पर पहले से ही सेट किए गए झंडे के अर्थ को दोहराना बहुत सुविधाजनक नहीं है, दूसरे टैब पर भी, लेकिन प्रोजेक्ट कॉन्फ़िगरेशन के अनुसार कम से कम एक बार ऐसा किया जा सकता है।

JetBrains को इस समस्या के बारे में पहले से ही पता है और उम्मीद है कि भविष्य के संस्करणों में, ReSharper द्वारा अनुबंधों का समर्थन किया जाएगा।

Nuance 2. संभवत: NullReferenceException

एक और सेटिंग जिसे अनुबंध के साथ रीशर की क्षमताओं को अधिकतम करने के लिए किया जाना चाहिए, वह है मूल्य विश्लेषण सेटिंग। विशेष रूप से, ReSharper null पर विधि मापदंडों के लिए चेकों की उपस्थिति / अनुपस्थिति का पता लगाने में सक्षम है और, इस तरह के चेक की अनुपस्थिति में एक तर्क वस्तु के तरीकों तक पहुँचते समय NullReferenceException अपवाद के संभावित फेंकने के बारे में चेतावनी देता है:



हालाँकि, डिफ़ॉल्ट रूप से, ReSharper अनुमान नहीं लगा सकता है कि अनुबंध पूर्व शर्त Contract.Requires(visitor != null) जोड़ रहा है। असमान Contract.Requires(visitor != null) null लिए आवश्यक जाँच प्रदान करता है।

सौभाग्य से, ReSharper में एक तथाकथित तंत्र है। बाहरी एनोटेशन, जो तृतीय-पक्ष पुस्तकालयों से कक्षाओं और तरीकों को चिह्नित करने की अनुमति देता है, जिसमें रीशर के लिए अतिरिक्त मेटा-जानकारी है। विशेष रूप से, ताकि ReSharper कॉन्ट्रैक्ट चेक को "पहचान" करने के लिए शुरू होता है, इसे Contract क्लास के तरीकों के मेटा विवरण के साथ एक विशेष xml-file को \ Bin \ ExternalAnnotations \ mscorlib \ फ़ोल्डर में जोड़ना होगा

 <assembly name="mscorlib"> <member name="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean, System.String)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Assume(System.Boolean)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Assume(System.Boolean, System.String)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Requires``1(System.Boolean)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean,System.String)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Requires``1(System.Boolean,System.String)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Invariant(System.Boolean)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> <member name="M:System.Diagnostics.Contracts.Contract.Invariant(System.Boolean,System.String)"> <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/> <parameter name="condition"> <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)"> <argument>0</argument> </attribute> </parameter> </member> </assembly> 

उसके बाद, सब कुछ जगह में गिर जाता है, और फिर आप अपने पसंदीदा टूल के सुझावों पर सहर्ष भरोसा कर सकते हैं बिना मामलों को ध्यान में रखते हुए जब यह गलत है क्योंकि कोडकॉन्ट्रैक्ट्स के उपयोग के कारण!