Saturday 15 September 2012

c# - Should I have a method name longer than its statement? -


.NET ढांचे के अनुसार:

एक्स नहीं पहचानकर्ता नाम के हिस्से के रूप में संक्षिप्ताक्षर या संकुचन का उपयोग करें।

उदाहरण के लिए, GetWin के बजाय GetWindow का उपयोग करें।

एक्स नहीं व्यापक रूप से स्वीकार किए जाते हैं, और भले ही वे हैं, केवल जब आवश्यक हो

मैंने एक बार विचार किया है कि GetName का उपयोग मेरी विधि के लिए किया जा सकता है, लेकिन मेरा मानना ​​है कि यह इतनी सार्थक रूप से सार्थक नहीं है।

नामकरण सम्मेलन से बहुत दूर नहीं हटने के लिए, मैंने व्यापक रूप से स्वीकृत परिवर्णी शब्द निकालने की कोशिश की है, लेकिन मैं निम्नलिखित विधियों के लिए केवल विचारों से बाहर चला हूं: < / P> <पूर्व> स्ट्रिंग GetExplicitInterfaceMemberImplementationName (सदस्य सूचना जानकारी) {वापसी जानकारी। अस्वीकरण टाइप करें। नाम + "।" + Info.Name; }

इस मामले के लिए, यह वास्तव में, बयान से वास्तव में लंबा नहीं है, लेकिन केवल समान लंबाई; और type.Delimiter को "" के बजाय प्रयोग किया जाना चाहिए। " हालांकि, नामकरण की समस्याएं अक्सर मुझे परेशान करती हैं

तो, मुझे किस विधि का नाम देना चाहिए? और दीर्घकालिक समाधानों के लिए, मैं क्या कर सकता हूं?

एक अतिरिक्त प्रश्न के लिए, क्या बॉक्स में से एक एपीआई एक ही चीज़ करता है?


1:

बंद करो और सोचो, मेरे लिए यह अच्छा सुझाव है

इसके बयान के उद्देश्य के लिए, शब्दार्थ के लिए और नामकरण सम्मेलनों को तोड़ने के लिए, मुझे [] से एक विचार मिला; इसलिए मैं अब इसे इस रूप में घोषित करता हूं:

  सार्वजनिक स्थिर स्ट्रिंग GetTypeQualifiedName (यह सदस्य जानकारी जानकारी) {return information.DeclaringType.Name + "।" + Info.Name; }   

फिर भी, कोई दीर्घकालिक हल नहीं आया है ..


संपादित करें 2:

मैं नहीं हूं सुनिश्चित करें कि क्या इस तरह के नाम के लिए यह एक अच्छा अभ्यास है ..

  सार्वजनिक स्थिर स्ट्रिंग GetTypeDotItsName (यह सदस्य जानकारी जानकारी) {return information.DeclaringType.Name + "।" + Info.Name; }    

1) उस जानकारी को रखें जो विधि के उद्देश्य को बनाने के लिए आवश्यक है स्पष्ट। आप संभवतः अपने उदाहरण के नाम को किसी भी हानि के बारे में समझने की हानि को कम कर सकते हैं।

2) दिशानिर्देश दिशा निर्देश हैं झुकाव से नियमों का पालन न करें जब वे काउंटर उत्पादक हो जाते हैं। यदि संक्षिप्त नाम का उपयोग करना कोड को पढ़ना और समझना आसान बनाता है, तो संक्षेप का उपयोग करें। मुख्य बात यह है कि संक्षिप्त नामों को लंबे नामों तक सीमित करने का प्रयास करना है, जो आमतौर पर उपयोग किए जाते हैं, और उनके लिए सहज और सामान्यतः इस्तेमाल किए गए संक्षिप्ताक्षर का उपयोग करते हैं, ताकि आपके कोड को पढ़ने वाले आसानी से उनका काम कर सकें। उदाहरण के लिए, घोषित घोषणा के लिए एक आम संक्षिप्त नाम है, और किसी और चीज़ के लिए गलती करने में मुश्किल है।

3) कभी-कभी आप समानार्थक शब्द का उपयोग करके संक्षिप्त करने की आवश्यकता से बच सकते हैं।

मुझे लगता है कि आप अर्थ को खोए बिना शायद आपके नाम से अंतरफलक और सदस्य को छोड़ सकते हैं। लेकिन शायद "स्पष्ट इंटरफ़ेस कार्यान्वयन नाम" वास्तव में "स्पष्ट नाम" है - विशेष रूप से एक अच्छी तरह से परिभाषित अर्थ है, विशेषकर संदर्भ में यदि आपकी कक्षा, और आप हमेशा अपने दस्तावेज़ टिप्पणी में पूरी तरह से निरोधक कानूनी परिभाषा जोड़ सकते हैं। इसलिए: "GetExplicitName"

No comments:

Post a Comment