2010-01-21 2 views
40

शब्दकोष के लिए सी # नामकरण के संबंध में, यदि मैं विंडोज एपीआई से संबंधित लाइब्रेरी लिख रहा था, तो क्या WindowsApi या WindowsAPI की ओर कोई मजबूत सम्मेलन है या क्या यह सिर्फ व्यक्तिगत वरीयता है?सी # नामकरण सम्मेलनों के लिए नामकरण सम्मेलन

उत्तर

40

एक सम्मेलन है, और यह प्रारंभिक अपरकेस, शेष लोअरकेस निर्दिष्ट करता है, जो कि सभी अक्षरों के लिए 2 वर्ण से अधिक लंबा है। इसलिए HttpContext और ClientID

+14

आईडी - बेहतर पूंजीकरण है। "दो अन्य शर्तें जो आम उपयोग में हैं, वे स्वयं ही एक श्रेणी में हैं, क्योंकि वे आम तौर पर संक्षेप में संक्षेप में हैं। दो शब्द" ठीक "और" आईडी "(और उन्हें दिखाए गए अनुसार cased किया जाना चाहिए) दिशानिर्देश के अपवाद हैं कि नहीं संक्षेप में नामों में इस्तेमाल किया जाना चाहिए "। "फ्रेमवर्क डिजाइन दिशानिर्देश" दूसरा संस्करण, पृष्ठ 4 .4। –

+19

किसी ने नोट किया कि यदि आईडी "पहचानकर्ता डेटा" ("पहचानकर्ता" के बजाय) के लिए खड़ा था, तो आईडी फिर से ठीक रहेगी। क्षमा करें, ठीक है फिर से। – peterchen

+2

@ सर्गी टेप्लाकोव माइक्रोसॉफ्ट दिशानिर्देशों का कहना है कि पास्कल का उपयोग केवल 2 अक्षरों से संक्षेप में संक्षेप में किया जाता है। आईडी और ओके के मामले में, सभी कैप्स ठीक है, हालांकि एचटीएमएल एचटीएमएल बन जाता है। http://msdn.microsoft.com/en-us/library/141e06ef(v=VS.71).aspx – smdrager

3

इसकी व्यक्तिगत वरीयता। लेकिन .NET WindowsApi का उपयोग करेगा। यह TcpClient के नामकरण के समान है।

7

मैंने सुना है कि आपको संक्षेप से बचना चाहिए, इसलिए यह WindowsApplicationProgrammingInterface बन जाएगा।

अधिक गंभीरता से (लोगों, गलत पढ़ने ऊपर होने लगते हैं नीचे बोली के बावजूद), this page का कहना है:

तीन या अधिक पत्र के किसी भी acronyms पास्कल मामला है, नहीं सभी को बड़े होना चाहिए।

के बाद से एपीआई एक प्रसिद्ध परिवर्णी शब्द माना जाता है, नाम WindowsApi एक अगर तुम दिशा निर्देशों का पालन करना चाहते हैं का चयन करना।

+2

लघुरूप ठीक है अगर वे डोमेन के भीतर अच्छी तरह से जाना जाता है। एपीआई प्रोग्रामिंग के भीतर जाना जाता है। –

+0

+1। फ्रेमवर्क दिशानिर्देश पुस्तक अनुशंसा करती है कि आप या तो संक्षेप या शब्दकोष से बचें या पास्कलकेस का उपयोग करें। मैं विंडोजएपीआई का सुझाव दूंगा। ढांचे से उदाहरण: उरी, उरीबिल्डर एचटीएमएलडेकोड। – Skurmedel

+1

@ जॉन: हाँ, मैं उस पर थोड़ा जीभ-इन-गाल था। :) – unwind

3

यह सब सिर्फ व्यक्तिगत (या संगठनात्मक) वरीयता है। जब तक आप सुसंगत हों, आप ठीक रहेगा।

.NET Framework स्वयं WindowsApi का उपयोग करेगा।

8

चेक माइक्रोसॉफ्ट आधिकारिक नामकरण यहाँ दिशा निर्देशों Naming Guidelines

+2

वह दस्तावेज़ .NET 1.1 के लिए है। –

+8

मुझे नहीं लगता कि इससे क्या फर्क पड़ता है? ऐसा नहीं है कि उन्होंने प्रत्येक संस्करण या कुछ के बीच सम्मेलनों को बदल दिया। – Skurmedel

+2

वहाँ डिज़ाइन दिशानिर्देश पुस्तक का दूसरा संस्करण _is_ है। मैंने यह निर्धारित करने के लिए तुलना नहीं की है कि नामकरण में कोई बदलाव नहीं है। –

24

"Framework Design Guidelines" क्रिस्टोफ़ क्वालीना और ब्रैड अब्राम द्वारा 2 संस्करण pp.40-42

3.1.2 एक्रोनिम्स

DO भुनाने ऊंट-केज्ड पहचानकर्ता के पहले शब्द को छोड़कर, दो वर्णों के शब्दकोष दोनों वर्ण।

System.IO 
public void StartIO(Stream ioStream) 

DO तीन या अधिक अक्षर के साथ acronyms की केवल पहली चरित्र भुनाने, ऊंट मामलों पहचानकर्ता का पहला शब्द को छोड़कर।

System.Xml 
public void ProcessHtmlTag(string htmlTag) 

नहीं किसी भी acronyms की वर्णों के किसी भी, जो कुछ भी उनकी लंबाई भुनाने करते हैं, एक ऊंट मामलों पहचानकर्ता की शुरुआत में।

1

FxCop पर भी एक नज़र डालें। यह एक अच्छी उपयोगिता है जो इस तरह के मुद्दों के साथ मदद करेगी।

1

पुराना सवाल, नया उत्तर।

MSDN Capitalization Conventions लेख की धारा ", संक्षिप्त के लिए पूंजीकरण नियम" के अनुसार:

, दो चरित्र acronyms की दोनों पात्रों भुनाने करो एक ऊंट मामलों पहचानकर्ता के पहला शब्द को छोड़कर।

एक संपत्ति DBRate नाम के एक छोटे से परिवर्णी शब्द (DB) एक पास्कल मामलों पहचानकर्ता का पहला शब्द के रूप में इस्तेमाल का एक उदाहरण है। ioChannel नामक एक पैरामीटर एक छोटी परिवर्णी शब्द (IO) एक ऊंट मामलों पहचानकर्ता का पहला शब्द के रूप में इस्तेमाल का एक उदाहरण है।

ऊंट-केज्ड पहचानकर्ता के पहले शब्द को छोड़कर, तीन या अधिक वर्णों के साथ केवल शब्दकोष के पहले अक्षर को कैपिटल करें।

एक वर्ग XmlWriter नाम के एक लंबे समय से एक पास्कल मामलों पहचानकर्ता के पहला शब्द के रूप में इस्तेमाल परिवर्णी शब्द का एक उदाहरण है। htmlReader नामक एक पैरामीटर ऊंट-केज्ड पहचानकर्ता के पहले शब्द के रूप में उपयोग किए जाने वाले लंबे परिवर्णी शब्द का एक उदाहरण है।

किसी भी शब्दकोष के किसी भी वर्ण को कैपिटल न करें, जो भी ऊंट-केज्ड पहचानकर्ता की शुरुआत में उनकी लंबाई है।

एक पैरामीटर xmlStream नाम के एक लंबे परिवर्णी शब्द (xml) का एक उदाहरण एक ऊंट मामलों पहचानकर्ता के पहले शब्द के रूप में प्रयोग किया जाता है। dbServerName नामक एक पैरामीटर एक छोटी परिवर्णी शब्द (db) एक ऊंट मामलों पहचानकर्ता के पहले शब्द के रूप में इस्तेमाल का एक उदाहरण है।